diff options
Diffstat (limited to 'INTERNAL_SERVER.md')
-rw-r--r-- | INTERNAL_SERVER.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/INTERNAL_SERVER.md b/INTERNAL_SERVER.md new file mode 100644 index 000000000..66bb3fcb6 --- /dev/null +++ b/INTERNAL_SERVER.md | |||
@@ -0,0 +1,38 @@ | |||
1 | <p align="center"> | ||
2 | <img src="./src/internal-server/public/images/logo.png" alt="" width="300"/> | ||
3 | </p> | ||
4 | |||
5 | # ferdi-internal-server | ||
6 | Internal Ferdi Server used for storing settings/preferences without logging into an external server. | ||
7 | |||
8 | ## Differences to ferdi-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 Ferdi's build script | ||
14 | - Only allows Ferdi clients to connect to the API | ||
15 | |||
16 | ## Configuration | ||
17 | franz-server's configuration is saved inside the `env.ini` file. Besides AdonisJS's settings, `ferdi-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, ferdi-internal-server can: | ||
19 | - Show the full Franz recipe library instead of only custom recipes | ||
20 | - Import Franz accounts | ||
21 | |||
22 | ## Importing your Franz account | ||
23 | `ferdi-internal-server` allows you to import your full Franz account, including all its settings. | ||
24 | |||
25 | To import your Franz account, open `http://localhost:45569/import` in your browser and login using your Franz account details. `ferdi-internal-server` will create a new user with the same credentials and copy your Franz settings, services and workspaces. | ||
26 | |||
27 | ## Development | ||
28 | |||
29 | You can locally develop `ferdi-internal-server` outside of Ferdi. | ||
30 | |||
31 | 1. Start the local server via | ||
32 | ```bash | ||
33 | npm run start:server | ||
34 | ``` | ||
35 | 2. Change Ferdi's server to `http://localhost:45568` to start using the local test server. | ||
36 | |||
37 | ## Note For previous contributors | ||
38 | For anyone who has *previously* setup Ferdi 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) | ||