aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatar OMKAR AGRAWAL <Omkaragrawal@users.noreply.github.com>2020-11-16 23:29:40 +0530
committerLibravatar OMKAR AGRAWAL <Omkaragrawal@users.noreply.github.com>2020-11-16 23:29:40 +0530
commit51deb85a89d076ee17d923e6cf1d51fb54e6e03a (patch)
tree0704a44bf36e0eccb642b5132e82d33771ba88b3 /README.md
parentMerge pull request #2 from Omkaragrawal/SSL-pg-mail (diff)
downloadferdium-server-51deb85a89d076ee17d923e6cf1d51fb54e6e03a.tar.gz
ferdium-server-51deb85a89d076ee17d923e6cf1d51fb54e6e03a.tar.zst
ferdium-server-51deb85a89d076ee17d923e6cf1d51fb54e6e03a.zip
Update Readme to include DB_SSL and MAIL_SSL
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 18 insertions, 5 deletions
diff --git a/README.md b/README.md
index b0424c2..33af145 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
1<p align="center"> 1<p align="center">
2 <img src="./logo.png" alt="" width="300"/> 2 <img src="./logo.png" alt="" width="300"/>
3</p> 3</p>
4 4
@@ -57,8 +57,10 @@ After setting up the docker container we recommend you to set up an NGINX revers
57 -e DB_USER=<yourdbuser> \ 57 -e DB_USER=<yourdbuser> \
58 -e DB_PASSWORD=<yourdbpass> \ 58 -e DB_PASSWORD=<yourdbpass> \
59 -e DB_DATABASE=<yourdbdatabase> \ 59 -e DB_DATABASE=<yourdbdatabase> \
60 -e DB_SSL=false \
60 -e IS_CREATION_ENABLED=true \ 61 -e IS_CREATION_ENABLED=true \
61 -e CONNECT_WITH_FRANZ=true \ 62 -e CONNECT_WITH_FRANZ=true \
63 -e MAIL_SSL=true/false \
62 -p <port>:80 \ 64 -p <port>:80 \
63 -v <path to data>:/config \ 65 -v <path to data>:/config \
64 -v <path to database>:/usr/src/app/database \ 66 -v <path to database>:/usr/src/app/database \
@@ -84,10 +86,12 @@ After setting up the docker container we recommend you to set up an NGINX revers
84 - DB_USER=<yourdbuser> 86 - DB_USER=<yourdbuser>
85 - DB_PASSWORD=<yourdbpass> 87 - DB_PASSWORD=<yourdbpass>
86 - DB_DATABASE=<yourdbdatabase> 88 - DB_DATABASE=<yourdbdatabase>
89 - DB_SSL=true/false
87 - IS_CREATION_ENABLED=true/false 90 - IS_CREATION_ENABLED=true/false
88 - CONNECT_WITH_FRANZ=true/false 91 - CONNECT_WITH_FRANZ=true/false
89 - IS_REGISTRATION_ENABLED=true/false 92 - IS_REGISTRATION_ENABLED=true/false
90 - IS_DASHBOARD_ENABLED=true/false 93 - IS_DASHBOARD_ENABLED=true/false
94 - MAIL_SSL=true/false
91 volumes: 95 volumes:
92 - <path to data>:/config 96 - <path to data>:/config
93 - <path to database>:/usr/src/app/database 97 - <path to database>:/usr/src/app/database
@@ -104,15 +108,24 @@ For more information on configuring the Docker image, visit the Docker image rep
1041. Clone this repository 1081. Clone this repository
1052. Install the [AdonisJS CLI](https://adonisjs.com/) 1092. Install the [AdonisJS CLI](https://adonisjs.com/)
1063. Copy `.env.example` to `.env` and edit the [configuration](#configuration) to your needs 1103. Copy `.env.example` to `.env` and edit the [configuration](#configuration) to your needs
1074. Run `npm install` to install local dependencies 1114. Have env DB_SSL=true only if your database is postgres and it is hosted online on platforms like GCP, AWS, etc
1085. Run the database migrations with 1125. Run `npm install` to install local dependencies
1136. Run the database migrations with
109 ```js 114 ```js
110 adonis migration:run 115 adonis migration:run
111 ``` 116 ```
1126. Start the server with 1177. Start the server with
113 ```js 118 ```js
114 adonis serve --dev 119 adonis serve --dev
115 ``` 120 ```
1218. If on previous step it does not run the server then run with
122 ```js
123 npm start
124 ```
125 or
126 ```js
127 node server.js
128 ```
116 129
117## Configuration 130## Configuration
118franz-server's configuration is saved inside the `.env` file. Besides AdonisJS's settings, ferdi-server has the following custom settings: 131franz-server's configuration is saved inside the `.env` file. Besides AdonisJS's settings, ferdi-server has the following custom settings: