theluyuan/shynet
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add syntax highlighting to GUIDE.md (#10)

Browse Source 
I enabled Syntax Highlighting in GUIDE.md for better readability
This commit is contained in:
0xflotus 2020-04-28 16:53:35 +02:00 committed by GitHub
parent dd6a9d1eaf
commit 73dad4cb6b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
GUIDE.md
View File

@ -31,7 +31,7 @@ Before continuing, please be sure to have the latest version of Docker installed
3. Configure an environment file for Shynet. (For example, create a file called `.env`.) Be sure to swap out the variables below with the correct values for your setup. (The comments refer to the lines that follow. Note that Docker is weird with quotes, so it tends to be better to omit them from your env file.) 3. Configure an environment file for Shynet. (For example, create a file called `.env`.) Be sure to swap out the variables below with the correct values for your setup. (The comments refer to the lines that follow. Note that Docker is weird with quotes, so it tends to be better to omit them from your env file.)
``` ```properties
# Database # Database
DB_NAME=<your db name> DB_NAME=<your db name>
DB_USER=<your db user> DB_USER=<your db user>
@ -58,7 +58,7 @@ SCRIPT_USE_HTTPS=True
For more advanced deployments, you may consider adding the following settings to your environment file. **The following settings are optional, and not required for simple deployments.** For more advanced deployments, you may consider adding the following settings to your environment file. **The following settings are optional, and not required for simple deployments.**
```env ```properties
# Email settings # Email settings
EMAIL_HOST_USER=<your SMTP email user> EMAIL_HOST_USER=<your SMTP email user>
EMAIL_HOST_PASSWORD=<your SMTP email password> EMAIL_HOST_PASSWORD=<your SMTP email password>
@ -129,7 +129,7 @@ If you are going to be running Shynet through a reverse proxy, please use the [B
8. Configure an environment file for Shynet. (For example, create a file called `.env`.) Be sure to swap out the variables below with the correct values for your setup. (The comments refer to the lines that follow. Note that Docker is weird with quotes, so it tends to be better to omit them from your env file.) 8. Configure an environment file for Shynet. (For example, create a file called `.env`.) Be sure to swap out the variables below with the correct values for your setup. (The comments refer to the lines that follow. Note that Docker is weird with quotes, so it tends to be better to omit them from your env file.)
``` ```properties
# Database # Database
DB_NAME=<your db name> DB_NAME=<your db name>
DB_USER=<your db user> DB_USER=<your db user>
@ -156,7 +156,7 @@ SCRIPT_USE_HTTPS=True
For more advanced deployments, you may consider adding the following settings to your environment file. **The following settings are optional, and not required for simple deployments.** For more advanced deployments, you may consider adding the following settings to your environment file. **The following settings are optional, and not required for simple deployments.**
```env ```properties
# Email settings # Email settings
EMAIL_HOST_USER=<your SMTP email user> EMAIL_HOST_USER=<your SMTP email user>
EMAIL_HOST_PASSWORD=<your SMTP email password> EMAIL_HOST_PASSWORD=<your SMTP email password>
@ -196,4 +196,4 @@ ONLY_SUPERUSERS_CREATE=False
--- ---
**Next steps:** while out of the scope of this short guide, next steps include setting up Shynet behind a reverse proxy (be it your own [Nginx server](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) or [Cloudflare](https://cloudflare.com)), making it run in the background, and integrating it on your sites. Integration instructions are available on each service's management page. **Next steps:** while out of the scope of this short guide, next steps include setting up Shynet behind a reverse proxy (be it your own [Nginx server](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) or [Cloudflare](https://cloudflare.com)), making it run in the background, and integrating it on your sites. Integration instructions are available on each service's management page.