diff options
author | thursday <xthursdayx@mailbox.org> | 2021-07-18 00:44:03 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-07-18 00:44:03 -0400 |
commit | 0f1bf1e42217f43f4846e4397b26759c148130a1 (patch) | |
tree | 29a4bfb8ab0c85f4840e96c963e8ff6fe4b09952 /README.md | |
parent | Update README.md (diff) | |
download | ferdium-server-0f1bf1e42217f43f4846e4397b26759c148130a1.tar.gz ferdium-server-0f1bf1e42217f43f4846e4397b26759c148130a1.tar.zst ferdium-server-0f1bf1e42217f43f4846e4397b26759c148130a1.zip |
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 16 |
1 files changed, 8 insertions, 8 deletions
@@ -19,10 +19,10 @@ Official Server software for the [Ferdi Messaging Browser](https://getferdi.com) | |||
19 | - [Contributing to Ferdi-server's development](#contributing-to-ferdi-servers-development) | 19 | - [Contributing to Ferdi-server's development](#contributing-to-ferdi-servers-development) |
20 | - [License](#license) | 20 | - [License](#license) |
21 | 21 | ||
22 | ## Why use a custom Ferdi server? | 22 | ## Why use a custom Ferdi-server? |
23 | A custom server allows you to manage the data of all registered users yourself and add your own recipes to the repository. | 23 | A custom server allows you to manage the data of all registered users yourself and add your own recipes to the repository. |
24 | 24 | ||
25 | If you are not interested in doing this you can use our official instance of Ferdi server at <https://api.getferdi.com>. | 25 | If you are not interested in doing this you can use our official instance of Ferdi-server at <https://api.getferdi.com>. |
26 | 26 | ||
27 | ## Features | 27 | ## Features |
28 | - [x] User registration and login | 28 | - [x] User registration and login |
@@ -30,16 +30,16 @@ If you are not interested in doing this you can use our official instance of Fer | |||
30 | - [x] Workspace support | 30 | - [x] Workspace support |
31 | - [x] Functioning service store | 31 | - [x] Functioning service store |
32 | - [x] User dashboard | 32 | - [x] User dashboard |
33 | - [x] Export/import data to other Ferdi-servers | 33 | - [x] Export/import data to other Ferdi servers |
34 | - [ ] Password recovery | 34 | - [ ] Password recovery |
35 | - [ ] Recipe update | 35 | - [ ] Recipe update |
36 | 36 | ||
37 | ## Setup | 37 | ## Setup |
38 | ### with Docker | 38 | ### with Docker |
39 | The easiest way to set up Ferdi server on your server is with Docker. | 39 | The easiest way to set up Ferdi-server on your server is with Docker. |
40 | 40 | ||
41 | The Docker image can be run as is, with the default SQLite database or you can modifying your ENV variables to use an external database (e.g. MySQL, MariaDB, Postgres, etc). | 41 | The Docker image can be run as is, with the default SQLite database or you can modify your ENV variables to use an external database (e.g. MySQL, MariaDB, Postgres, etc). |
42 | After setting up the docker container we recommend you set up an NGINX reverse proxy to access Ferdi-server outside of your home network and protect it with an SSL certificate. | 42 | After setting up the docker container we recommend you set up an NGINX reverse proxy to access Ferdi server outside of your home network and protect it with an SSL certificate. |
43 | 43 | ||
44 | **Warning**, please note that the use of the previous `config.txt` is now deprecated and a number of environmental variables have changed, specifically the default database name and location, the internal container port, and an additional `DATA_DIR` variable has been added. Make sure to pass the correct environmental variables to your container at runtime. If you are an existing Ferdi-server user please see [the Ferdi docker documentation](./docker/README.md) and the example [docker-compose.yml](./docker/docker-compose.yml) for more information about migrating to the new image. | 44 | **Warning**, please note that the use of the previous `config.txt` is now deprecated and a number of environmental variables have changed, specifically the default database name and location, the internal container port, and an additional `DATA_DIR` variable has been added. Make sure to pass the correct environmental variables to your container at runtime. If you are an existing Ferdi-server user please see [the Ferdi docker documentation](./docker/README.md) and the example [docker-compose.yml](./docker/docker-compose.yml) for more information about migrating to the new image. |
45 | 45 | ||
@@ -83,7 +83,7 @@ After setting up the docker container we recommend you set up an NGINX reverse p | |||
83 | 83 | ||
84 | Alternatively, you can also use docker-compose v2 schema. An example can be found [in the docker folder](./docker/docker-compose.yml). | 84 | Alternatively, you can also use docker-compose v2 schema. An example can be found [in the docker folder](./docker/docker-compose.yml). |
85 | 85 | ||
86 | 3. 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). | 86 | 3. Optionally, you can [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). |
87 | 87 | ||
88 | For more information on configuring the Docker image, please read [the ferdi docker documentation](./docker/README.md). | 88 | For more information on configuring the Docker image, please read [the ferdi docker documentation](./docker/README.md). |
89 | 89 | ||
@@ -118,7 +118,7 @@ franz-server's configuration is saved inside an `.env` file. Besides AdonisJS's | |||
118 | 118 | ||
119 | ## Importing your Franz account | 119 | ## Importing your Franz account |
120 | 120 | ||
121 | ferdi-server allows you to import your full Franz account, including all its settings. | 121 | Ferdi-server allows you to import your full Franz account, including all its settings. |
122 | 122 | ||
123 | To import your Franz account, open `http://[YOUR FERDI-SERVER]/import` in your browser and login using your Franz account details. ferdi-server will create a new user with the same credentials and copy your Franz settings, services and workspaces. | 123 | To import your Franz account, open `http://[YOUR FERDI-SERVER]/import` in your browser and login using your Franz account details. ferdi-server will create a new user with the same credentials and copy your Franz settings, services and workspaces. |
124 | 124 | ||