aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar Michal Kostewicz <m.kostewicz84@gmail.com>2021-02-07 14:23:57 +0100
committerLibravatar Michal Kostewicz <m.kostewicz84@gmail.com>2021-02-07 14:23:57 +0100
commit02000d89159ba171cabbd341139871236f3df386 (patch)
treec1b4806a347fa6e6b224f42eae36011a71e24309 /README.md
parentChange database.js so any system folder can be used to keep database files (diff)
downloadferdium-server-02000d89159ba171cabbd341139871236f3df386.tar.gz
ferdium-server-02000d89159ba171cabbd341139871236f3df386.tar.zst
ferdium-server-02000d89159ba171cabbd341139871236f3df386.zip
Revert line which choose DB folder using env. Move Dockerfile to root. Simplify export in entrypoint. Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 1 insertions, 39 deletions
diff --git a/README.md b/README.md
index 9d1b02d..60de4fc 100644
--- a/README.md
+++ b/README.md
@@ -78,45 +78,7 @@ After setting up the docker container we recommend you to set up an NGINX revers
78 getferdi/ferdi-server 78 getferdi/ferdi-server
79 ``` 79 ```
80 80
81 Alternatively, you can also use docker-compose v2 schemas 81 Alternatively, you can also use docker-compose v2 schemas. An example can be found in [./docker/docker-compose.yml](https://github.com/getferdi/server/tree/master/docker/docker-compose.yml) file.
82
83 ```sh
84 ---
85 version: "2"
86 services:
87 ferdi-server:
88 image: getferdi/ferdi-server
89 container_name: ferdi-server
90 environment:
91 - NODE_ENV=development
92 - EXTERNAL_DOMAIN=<ferdi-serverdomain>
93 - DB_CONNECTION=<database>
94 - DB_HOST=<yourdbhost>
95 - DB_PORT=<yourdbPORT>
96 - DB_USER=<yourdbuser>
97 - DB_PASSWORD=<yourdbpass>
98 - DB_DATABASE=<yourdbdatabase>
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>
107 - IS_CREATION_ENABLED=true/false
108 - IS_DASHBOARD_ENABLED=true/false
109 - IS_REGISTRATION_ENABLED=true/false
110 - CONNECT_WITH_FRANZ=true/false
111 volumes:
112 - <path to data>:/config
113 - <path to database>:/app/database
114 - <path to recipes>:/app/recipes
115 ports:
116 - <port>:80
117 restart: unless-stopped
118 ```
119 You can also use sample [./docker/docker-compose.yml](https://github.com/getferdi/server/tree/master/docker/docker-compose.yml) file.
120 82
1213. Optionally, you can now [set up Nginx as a reverse proxy](https://www.digitalocean.com/community/tutorials/how-to-set-up-a-node-js-application-for-production-on-ubuntu-16-04#set-up-nginx-as-a-reverse-proxy-server). 833. Optionally, you can now [set up Nginx as a reverse proxy](https://www.digitalocean.com/community/tutorials/how-to-set-up-a-node-js-application-for-production-on-ubuntu-16-04#set-up-nginx-as-a-reverse-proxy-server).
122 84