From 210131ca184c3aa043371857c022aa1aa149efbf Mon Sep 17 00:00:00 2001 From: Aditya Mangalampalli Date: Fri, 15 Apr 2022 02:00:25 -0700 Subject: Matched casing for almost all replacements --- INTERNAL_SERVER.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) (limited to 'INTERNAL_SERVER.md') diff --git a/INTERNAL_SERVER.md b/INTERNAL_SERVER.md index 66bb3fcb6..1cfa3b1f0 100644 --- a/INTERNAL_SERVER.md +++ b/INTERNAL_SERVER.md @@ -2,37 +2,37 @@

-# ferdi-internal-server -Internal Ferdi Server used for storing settings/preferences without logging into an external server. +# ferdium-internal-server +Internal Ferdium Server used for storing settings/preferences without logging into an external server. -## Differences to ferdi-server +## Differences to ferdium-server - Doesn't contain user management (only one user) - Doesn't require logging in - No recipe creation - Contains `start.js` script to allow starting the server via script -- Uses `env.ini` instead of `.env` to stay compatible with Ferdi's build script -- Only allows Ferdi clients to connect to the API +- Uses `env.ini` instead of `.env` to stay compatible with Ferdium's build script +- Only allows Ferdium clients to connect to the API ## Configuration -franz-server's configuration is saved inside the `env.ini` file. Besides AdonisJS's settings, `ferdi-internal-server` has the following custom settings: -- `CONNECT_WITH_FRANZ` (`true` or `false`, default: `true`): Whether to enable connections to the Franz server. By enabling this option, ferdi-internal-server can: +franz-server's configuration is saved inside the `env.ini` file. Besides AdonisJS's settings, `ferdium-internal-server` has the following custom settings: +- `CONNECT_WITH_FRANZ` (`true` or `false`, default: `true`): Whether to enable connections to the Franz server. By enabling this option, ferdium-internal-server can: - Show the full Franz recipe library instead of only custom recipes - Import Franz accounts ## Importing your Franz account -`ferdi-internal-server` allows you to import your full Franz account, including all its settings. +`ferdium-internal-server` allows you to import your full Franz account, including all its settings. -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. +To 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. ## Development -You can locally develop `ferdi-internal-server` outside of Ferdi. +You can locally develop `ferdium-internal-server` outside of Ferdium. 1. Start the local server via ```bash npm run start:server ``` -2. Change Ferdi's server to `http://localhost:45568` to start using the local test server. +2. Change Ferdium's server to `http://localhost:45568` to start using the local test server. ## Note For previous contributors -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) +For 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) -- cgit v1.2.3-54-g00ecf