diff options
author | Bennett <hello@vantezzen.io> | 2020-03-10 16:06:45 +0100 |
---|---|---|
committer | Bennett <hello@vantezzen.io> | 2020-03-10 16:06:45 +0100 |
commit | f2b2f8bc74fc67805d733cbd039da824bd49eae0 (patch) | |
tree | 1569b3bb9e49108b0a4d3b1922333dd03f9ff141 /README.md | |
parent | Bump version number (diff) | |
download | ferdium-server-f2b2f8bc74fc67805d733cbd039da824bd49eae0.tar.gz ferdium-server-f2b2f8bc74fc67805d733cbd039da824bd49eae0.tar.zst ferdium-server-f2b2f8bc74fc67805d733cbd039da824bd49eae0.zip |
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 36 |
1 files changed, 24 insertions, 12 deletions
@@ -3,16 +3,25 @@ | |||
3 | </p> | 3 | </p> |
4 | 4 | ||
5 | # ferdi-server | 5 | # ferdi-server |
6 | Unofficial Franz server replacement for use with the Ferdi Client. | 6 | Official Server software for the [Ferdi Messaging Browser](https://getferdi.com) |
7 | 7 | ||
8 | ## Looking for a smaller alternative? | 8 | - [ferdi-server](#ferdi-server) |
9 | [ferdi-slim-server](https://github.com/vantezzen/ferdi-slim-server) is a slim alternative to this project. Opposed to ferdi-server, ferdi-slim-server is only a wrapper around the Franz API that allows you to add custom recipes while still using the original Franz API. | 9 | - [Why use a custom Ferdi server?](#why-use-a-custom-ferdi-server) |
10 | 10 | - [Features](#features) | |
11 | ## Why use a custom ferdi-server? | 11 | - [Setup](#setup) |
12 | A custom ferdi-server allows you to experience the full potential of the Ferdi client. It allows you to use all Premium features (e.g. Workspaces and custom URL recipes) and [adding your own recipes](#creating-and-using-custom-recipes). | 12 | - [with Docker](#with-docker) |
13 | 13 | - [Manual setup](#manual-setup) | |
14 | ## Demo | 14 | - [Configuration](#configuration) |
15 | You can find Ferdi's official API running this software at <https://api.getferdi.com> | 15 | - [Importing your Franz account](#importing-your-franz-account) |
16 | - [Transferring user data](#transferring-user-data) | ||
17 | - [Creating and using custom recipes](#creating-and-using-custom-recipes) | ||
18 | - [Listing custom recipes](#listing-custom-recipes) | ||
19 | - [License](#license) | ||
20 | |||
21 | ## Why use a custom Ferdi server? | ||
22 | A custom server allows you to manage the data of all registered users yourself and add your own recipes to the repository. | ||
23 | |||
24 | If you are not interested in doing this you can use our official instance of Ferdi server at <https://api.getferdi.com>. | ||
16 | 25 | ||
17 | ## Features | 26 | ## Features |
18 | - [x] User registration and login | 27 | - [x] User registration and login |
@@ -20,13 +29,13 @@ You can find Ferdi's official API running this software at <https://api.getferdi | |||
20 | - [x] Workspace support | 29 | - [x] Workspace support |
21 | - [x] Functioning service store | 30 | - [x] Functioning service store |
22 | - [x] User dashboard | 31 | - [x] User dashboard |
32 | - [x] Export/import data to other ferdi-servers | ||
23 | - [ ] Password recovery | 33 | - [ ] Password recovery |
24 | - [ ] Export/import data to other ferdi-servers | ||
25 | - [ ] Recipe update | 34 | - [ ] Recipe update |
26 | 35 | ||
27 | ## Setup | 36 | ## Setup |
28 | ### with Docker | 37 | ### with Docker |
29 | The easiest way to set up ferdi-server on your server is with Docker. | 38 | The easiest way to set up Ferdi server on your server is with Docker. |
30 | 39 | ||
31 | 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). | 40 | 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). |
32 | After setting up the docker container we recommend you to set up an NGINX reverse proxy to access ferdi-server outside of your home network and protect it with an SSL certificate. | 41 | After setting up the docker container we recommend you to set up an NGINX reverse proxy to access ferdi-server outside of your home network and protect it with an SSL certificate. |
@@ -119,6 +128,9 @@ ferdi-server allows you to import your full Franz account, including all its set | |||
119 | 128 | ||
120 | 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. | 129 | 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. |
121 | 130 | ||
131 | ## Transferring user data | ||
132 | Please refer to <https://github.com/getferdi/ferdi/wiki/Transferring-data-between-servers> | ||
133 | |||
122 | ## Creating and using custom recipes | 134 | ## Creating and using custom recipes |
123 | ferdi-server allows to extends the Franz recipe catalogue with custom Ferdi recipes. | 135 | ferdi-server allows to extends the Franz recipe catalogue with custom Ferdi recipes. |
124 | 136 | ||