diff options
Diffstat (limited to 'docs/INTERNAL_SERVER.md')
-rw-r--r-- | docs/INTERNAL_SERVER.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/INTERNAL_SERVER.md b/docs/INTERNAL_SERVER.md new file mode 100644 index 000000000..9e94f9bdf --- /dev/null +++ b/docs/INTERNAL_SERVER.md | |||
@@ -0,0 +1,28 @@ | |||
1 | <p align="center"> | ||
2 | <img src="../src/internal-server/public/images/logo.png" alt="" width="300"/> | ||
3 | </p> | ||
4 | |||
5 | # ferdium-internal-server | ||
6 | Internal Ferdium Server used for storing settings/preferences without logging into an external server. | ||
7 | |||
8 | ## Differences to ferdium-server | ||
9 | - Doesn't contain user management (only one user) | ||
10 | - Doesn't require logging in | ||
11 | - No recipe creation | ||
12 | - Contains `start.js` script to allow starting the server via script | ||
13 | - Uses `env.ini` instead of `.env` to stay compatible with Ferdium's build script | ||
14 | - Only allows Ferdium clients to connect to the API | ||
15 | |||
16 | ## Configuration | ||
17 | `ferdium-internal-server's` configuration is saved inside the `env.ini` file. Besides AdonisJS's settings, `ferdium-internal-server` has the following custom settings: | ||
18 | - `CONNECT_WITH_FRANZ` (`true` or `false`, default: `true`): Whether to enable connections to the Franz server. By enabling this option, `ferdium-internal-server` can: | ||
19 | - Show the full Franz/Ferdi recipe library instead of only custom recipes | ||
20 | - Import Franz/Ferdi accounts | ||
21 | |||
22 | ## Exporting backups | ||
23 | Since the `ferdium-internal-server` runs a local server, there's no automatic syncing of settings possible. You can backup your settings, by clicking on `Help > Import/Export Configuration Data` which will open the running server page in your browser. Choose the option to export and save the generated file. | ||
24 | |||
25 | ## Importing your Franz/Ferdi account | ||
26 | `ferdium-internal-server` allows you to import your full Franz account, including all its settings. | ||
27 | |||
28 | To import your Franz/Ferdi account, within Ferdium, click on `Help > Import/Export Configuration Data` which will open the running server page in your browser. You can then login using your Franz account details. `ferdium-internal-server` will create a new user with the same credentials and copy your Franz settings, services and workspaces. | ||