aboutsummaryrefslogtreecommitdiffstats
path: root/src/server/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/server/README.md')
-rw-r--r--src/server/README.md17
1 files changed, 0 insertions, 17 deletions
diff --git a/src/server/README.md b/src/server/README.md
deleted file mode 100644
index 0074f2314..000000000
--- a/src/server/README.md
+++ /dev/null
@@ -1,17 +0,0 @@
1<p align="center">
2 <img src="./logo.png" alt="" width="300"/>
3</p>
4
5# ferdi-internal-server
6Internal Ferdi Server used for storing settings without logging into an external server.
7
8## Configuration
9franz-server's configuration is saved inside the `env.ini` file. Besides AdonisJS's settings, ferdi-internal-server has the following custom settings:
10- `CONNECT_WITH_FRANZ` (`true` or `false`, default: `true`): Whether to enable connections to the Franz server. By enabling this option, ferdi-server can:
11 - Show the full Franz recipe library instead of only custom recipes
12 - Import Franz accounts
13
14## Importing your Franz account
15ferdi-server allows you to import your full Franz account, including all its settings.
16
17To import your Franz account, open `http://localhost:45569/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.