diff options
author | xthursdayx <xthursdayx@mailbox.org> | 2021-01-19 15:06:25 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-01-19 15:06:25 -0500 |
commit | 5b03ef3aefca1d7aa74aac7536172c269e26eb6a (patch) | |
tree | 15d5b97c0ef2d3dc8c3bacbfd5842de7bb01a36c | |
parent | Merge pull request #41 from Omkaragrawal/update-Readme (diff) | |
download | ferdium-server-5b03ef3aefca1d7aa74aac7536172c269e26eb6a.tar.gz ferdium-server-5b03ef3aefca1d7aa74aac7536172c269e26eb6a.tar.zst ferdium-server-5b03ef3aefca1d7aa74aac7536172c269e26eb6a.zip |
Update README.md
-rw-r--r-- | README.md | 42 |
1 files changed, 29 insertions, 13 deletions
@@ -47,26 +47,35 @@ After setting up the docker container we recommend you to set up an NGINX revers | |||
47 | ``` | 47 | ``` |
48 | 2. Create a new Docker container with your desired configuration | 48 | 2. Create a new Docker container with your desired configuration |
49 | 49 | ||
50 | ```sh | 50 | ```sh |
51 | docker create \ | 51 | docker create \ |
52 | --name=ferdi-server \ | 52 | --name=ferdi-server \ |
53 | -e NODE_ENV=development \ | 53 | -e NODE_ENV=development \ |
54 | -e EXTERNAL_DOMAIN=<ferdi-serverdomain> \ | ||
54 | -e DB_CONNECTION=<database> \ | 55 | -e DB_CONNECTION=<database> \ |
55 | -e DB_HOST=<yourdbhost> \ | 56 | -e DB_HOST=<yourdbhost> \ |
56 | -e DB_PORT=<yourdbPORT> \ | 57 | -e DB_PORT=<yourdbport> \ |
57 | -e DB_USER=<yourdbuser> \ | 58 | -e DB_USER=<yourdbuser> \ |
58 | -e DB_PASSWORD=<yourdbpass> \ | 59 | -e DB_PASSWORD=<yourdbpass> \ |
59 | -e DB_DATABASE=<yourdbdatabase> \ | 60 | -e DB_DATABASE=<yourdbdatabase> \ |
60 | -e DB_SSL=false \ | 61 | -e DB_SSL=false \ |
62 | -e MAIL_CONNECTION=smtp \ | ||
63 | -e SMPT_HOST=<smtpmailserver> \ | ||
64 | -e SMTP_PORT=<smtpport> \ | ||
65 | -e MAIL_SSL=true/false \ | ||
66 | -e MAIL_USERNAME=<yourmailusername> \ | ||
67 | -e MAIL_PASSWORD=<yourmailpassword> \ | ||
68 | -e MAIL_SENDER=<sendemailaddress> \ | ||
61 | -e IS_CREATION_ENABLED=true \ | 69 | -e IS_CREATION_ENABLED=true \ |
70 | -e IS_DASHBOARD_ENABLED=true \ | ||
71 | -e IS_REGISTRATION_ENABLED=true \ | ||
62 | -e CONNECT_WITH_FRANZ=true \ | 72 | -e CONNECT_WITH_FRANZ=true \ |
63 | -e MAIL_SSL=true/false \ | ||
64 | -p <port>:80 \ | 73 | -p <port>:80 \ |
65 | -v <path to data>:/config \ | 74 | -v <path to data>:/config \ |
66 | -v <path to database>:/usr/src/app/database \ | 75 | -v <path to database>:/app/database \ |
67 | -v <path to recipes>:/usr/src/app/recipes \ | 76 | -v <path to recipes>:/app/recipes \ |
68 | --restart unless-stopped \ | 77 | --restart unless-stopped \ |
69 | getferdi/ferdi-server | 78 | getferdi/ferdi-server |
70 | ``` | 79 | ``` |
71 | 80 | ||
72 | Alternatively, you can also use docker-compose v2 schemas | 81 | Alternatively, you can also use docker-compose v2 schemas |
@@ -80,6 +89,7 @@ After setting up the docker container we recommend you to set up an NGINX revers | |||
80 | container_name: ferdi-server | 89 | container_name: ferdi-server |
81 | environment: | 90 | environment: |
82 | - NODE_ENV=development | 91 | - NODE_ENV=development |
92 | - EXTERNAL_DOMAIN=<ferdi-serverdomain> | ||
83 | - DB_CONNECTION=<database> | 93 | - DB_CONNECTION=<database> |
84 | - DB_HOST=<yourdbhost> | 94 | - DB_HOST=<yourdbhost> |
85 | - DB_PORT=<yourdbPORT> | 95 | - DB_PORT=<yourdbPORT> |
@@ -87,15 +97,21 @@ After setting up the docker container we recommend you to set up an NGINX revers | |||
87 | - DB_PASSWORD=<yourdbpass> | 97 | - DB_PASSWORD=<yourdbpass> |
88 | - DB_DATABASE=<yourdbdatabase> | 98 | - DB_DATABASE=<yourdbdatabase> |
89 | - DB_SSL=true/false | 99 | - DB_SSL=true/false |
100 | - MAIL_CONNECTION=<mailsender> | ||
101 | - SMPT_HOST=<smtpmailserver> | ||
102 | - SMTP_PORT=<smtpport> | ||
103 | - MAIL_SSL=true/false | ||
104 | - MAIL_USERNAME=<yourmailusername> | ||
105 | - MAIL_PASSWORD=<yourmailpassword> | ||
106 | - MAIL_SENDER=<sendemailaddress> | ||
90 | - IS_CREATION_ENABLED=true/false | 107 | - IS_CREATION_ENABLED=true/false |
91 | - CONNECT_WITH_FRANZ=true/false | ||
92 | - IS_REGISTRATION_ENABLED=true/false | ||
93 | - IS_DASHBOARD_ENABLED=true/false | 108 | - IS_DASHBOARD_ENABLED=true/false |
94 | - MAIL_SSL=true/false | 109 | - IS_REGISTRATION_ENABLED=true/false |
110 | - CONNECT_WITH_FRANZ=true/false | ||
95 | volumes: | 111 | volumes: |
96 | - <path to data>:/config | 112 | - <path to data>:/config |
97 | - <path to database>:/usr/src/app/database | 113 | - <path to database>:/app/database |
98 | - <path to recipes>:/usr/src/app/recipes | 114 | - <path to recipes>:/app/recipes |
99 | ports: | 115 | ports: |
100 | - <port>:80 | 116 | - <port>:80 |
101 | restart: unless-stopped | 117 | restart: unless-stopped |