diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 23 |
1 files changed, 18 insertions, 5 deletions
@@ -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 | |||
104 | 1. Clone this repository | 108 | 1. Clone this repository |
105 | 2. Install the [AdonisJS CLI](https://adonisjs.com/) | 109 | 2. Install the [AdonisJS CLI](https://adonisjs.com/) |
106 | 3. Copy `.env.example` to `.env` and edit the [configuration](#configuration) to your needs | 110 | 3. Copy `.env.example` to `.env` and edit the [configuration](#configuration) to your needs |
107 | 4. Run `npm install` to install local dependencies | 111 | 4. Have env DB_SSL=true only if your database is postgres and it is hosted online on platforms like GCP, AWS, etc |
108 | 5. Run the database migrations with | 112 | 5. Run `npm install` to install local dependencies |
113 | 6. Run the database migrations with | ||
109 | ```js | 114 | ```js |
110 | adonis migration:run | 115 | adonis migration:run |
111 | ``` | 116 | ``` |
112 | 6. Start the server with | 117 | 7. Start the server with |
113 | ```js | 118 | ```js |
114 | adonis serve --dev | 119 | adonis serve --dev |
115 | ``` | 120 | ``` |
121 | 8. 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 |
118 | franz-server's configuration is saved inside the `.env` file. Besides AdonisJS's settings, ferdi-server has the following custom settings: | 131 | franz-server's configuration is saved inside the `.env` file. Besides AdonisJS's settings, ferdi-server has the following custom settings: |