aboutsummaryrefslogtreecommitdiffstats
path: root/INTERNAL_SERVER.md
diff options
context:
space:
mode:
authorLibravatar Vijay A <vraravam@users.noreply.github.com>2022-04-24 09:01:56 -0500
committerLibravatar Vijay A <vraravam@users.noreply.github.com>2022-04-24 09:01:56 -0500
commit4403194ec9cf22e467567b400c6c2ec42766af3f (patch)
treea7dcef7cca4f84f1a17fa2f8f3bfad9d467d5bfd /INTERNAL_SERVER.md
parentMade 'macos-notification-state' an optional dependency so that it doesn't aff... (diff)
downloadferdium-app-4403194ec9cf22e467567b400c6c2ec42766af3f.tar.gz
ferdium-app-4403194ec9cf22e467567b400c6c2ec42766af3f.tar.zst
ferdium-app-4403194ec9cf22e467567b400c6c2ec42766af3f.zip
Updated information about the internal server that Ferdium uses for accountless mode
Diffstat (limited to 'INTERNAL_SERVER.md')
-rw-r--r--INTERNAL_SERVER.md24
1 files changed, 7 insertions, 17 deletions
diff --git a/INTERNAL_SERVER.md b/INTERNAL_SERVER.md
index 1cfa3b1f0..fcf8cf6af 100644
--- a/INTERNAL_SERVER.md
+++ b/INTERNAL_SERVER.md
@@ -14,25 +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
17franz-server's configuration is saved inside the `env.ini` file. Besides AdonisJS's settings, `ferdium-internal-server` has the following custom settings: 17ferdium-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 recipe library instead of only custom recipes 19 - Show the full Franz/Ferdi recipe library instead of only custom recipes
20 - Import Franz accounts 20 - Import Franz/Ferdi accounts
21 21
22## Importing your Franz account 22## Importing your Franz/Ferdi account
23`ferdium-internal-server` allows you to import your full Franz account, including all its settings. 23`ferdium-internal-server` allows you to import your full Franz account, including all its settings.
24 24
25To import your Franz account, open `http://localhost:45569/import` in your browser and 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. 25To 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## Development
28
29You can locally develop `ferdium-internal-server` outside of Ferdium.
30
311. Start the local server via
32 ```bash
33 npm run start:server
34 ```
352. Change Ferdium's server to `http://localhost:45568` to start using the local test server.
36 26
37## Note For previous contributors 27## Note For previous contributors
38For anyone who has *previously* setup Ferdium for development, you will need to unregister the `src/internal-server` from being 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) 28For 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)