diff options
Diffstat (limited to 'INTERNAL_SERVER.md')
-rw-r--r-- | INTERNAL_SERVER.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/INTERNAL_SERVER.md b/INTERNAL_SERVER.md index fcf8cf6af..1a1284f7e 100644 --- a/INTERNAL_SERVER.md +++ b/INTERNAL_SERVER.md | |||
@@ -14,15 +14,15 @@ Internal Ferdium Server used for storing settings/preferences without logging in | |||
14 | - Only allows Ferdium clients to connect to the API | 14 | - Only allows Ferdium clients to connect to the API |
15 | 15 | ||
16 | ## Configuration | 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: | 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: | 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 | 19 | - Show the full Franz/Ferdi recipe library instead of only custom recipes |
20 | - Import Franz/Ferdi accounts | 20 | - Import Franz/Ferdi accounts |
21 | 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 | |||
22 | ## Importing your Franz/Ferdi account | 25 | ## Importing your Franz/Ferdi account |
23 | `ferdium-internal-server` allows you to import your full Franz account, including all its settings. | 26 | `ferdium-internal-server` allows you to import your full Franz account, including all its settings. |
24 | 27 | ||
25 | 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. | 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. |
26 | |||
27 | ## Note For previous contributors | ||
28 | For anyone who has _previously_ setup Ferdium for development, you will need to unregister the `src/internal-server` from being tracked as a git submodule. You can do this by following the steps outlined [here](https://www.w3docs.com/snippets/git/how-to-remove-a-git-submodule.html) | ||