aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 29 insertions, 13 deletions
diff --git a/README.md b/README.md
index 6aa2d02..b0424c2 100644
--- a/README.md
+++ b/README.md
@@ -3,16 +3,25 @@
3</p> 3</p>
4 4
5# ferdi-server 5# ferdi-server
6Unofficial Franz server replacement for use with the Ferdi Client. 6Official 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)
12A 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)
15You 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?
22A custom server allows you to manage the data of all registered users yourself and add your own recipes to the repository.
23
24If 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
29The easiest way to set up ferdi-server on your server is with Docker. 38The easiest way to set up Ferdi server on your server is with Docker.
30 39
31The 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). 40The 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).
32After 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. 41After 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.
@@ -76,7 +85,9 @@ After setting up the docker container we recommend you to set up an NGINX revers
76 - DB_PASSWORD=<yourdbpass> 85 - DB_PASSWORD=<yourdbpass>
77 - DB_DATABASE=<yourdbdatabase> 86 - DB_DATABASE=<yourdbdatabase>
78 - IS_CREATION_ENABLED=true/false 87 - IS_CREATION_ENABLED=true/false
79 - CONNECT_WITH_FRANZ=true/flase 88 - CONNECT_WITH_FRANZ=true/false
89 - IS_REGISTRATION_ENABLED=true/false
90 - IS_DASHBOARD_ENABLED=true/false
80 volumes: 91 volumes:
81 - <path to data>:/config 92 - <path to data>:/config
82 - <path to database>:/usr/src/app/database 93 - <path to database>:/usr/src/app/database
@@ -106,6 +117,8 @@ For more information on configuring the Docker image, visit the Docker image rep
106## Configuration 117## Configuration
107franz-server's configuration is saved inside the `.env` file. Besides AdonisJS's settings, ferdi-server has the following custom settings: 118franz-server's configuration is saved inside the `.env` file. Besides AdonisJS's settings, ferdi-server has the following custom settings:
108- `IS_CREATION_ENABLED` (`true` or `false`, default: `true`): Whether to enable the [creation of custom recipes](#creating-and-using-custom-recipes) 119- `IS_CREATION_ENABLED` (`true` or `false`, default: `true`): Whether to enable the [creation of custom recipes](#creating-and-using-custom-recipes)
120- `IS_REGISTRATION_ENABLED` (`true` or `false`, default: `true`): Whether to enable the creation of new user accounts
121- `IS_DASHBOARD_ENABLED` (`true` or `false`, default: `true`): Whether to enable the user dashboard
109- `CONNECT_WITH_FRANZ` (`true` or `false`, default: `true`): Whether to enable connections to the Franz server. By enabling this option, ferdi-server can: 122- `CONNECT_WITH_FRANZ` (`true` or `false`, default: `true`): Whether to enable connections to the Franz server. By enabling this option, ferdi-server can:
110 - Show the full Franz recipe library instead of only custom recipes 123 - Show the full Franz recipe library instead of only custom recipes
111 - Import Franz accounts 124 - Import Franz accounts
@@ -115,6 +128,9 @@ ferdi-server allows you to import your full Franz account, including all its set
115 128
116To 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. 129To 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.
117 130
131## Transferring user data
132Please refer to <https://github.com/getferdi/ferdi/wiki/Transferring-data-between-servers>
133
118## Creating and using custom recipes 134## Creating and using custom recipes
119ferdi-server allows to extends the Franz recipe catalogue with custom Ferdi recipes. 135ferdi-server allows to extends the Franz recipe catalogue with custom Ferdi recipes.
120 136