diff options
author | Aditya Mangalampalli <aditya.mangalampalli@gmail.com> | 2022-04-15 02:00:25 -0700 |
---|---|---|
committer | Vijay A <vraravam@users.noreply.github.com> | 2022-04-16 21:57:57 +0530 |
commit | 210131ca184c3aa043371857c022aa1aa149efbf (patch) | |
tree | 6bc4e10a1540e55a66146c099bc468a12287425e /INTERNAL_SERVER.md | |
parent | Update submodule url to ferdium-recipes (#1) (diff) | |
download | ferdium-app-210131ca184c3aa043371857c022aa1aa149efbf.tar.gz ferdium-app-210131ca184c3aa043371857c022aa1aa149efbf.tar.zst ferdium-app-210131ca184c3aa043371857c022aa1aa149efbf.zip |
Matched casing for almost all replacements
Diffstat (limited to 'INTERNAL_SERVER.md')
-rw-r--r-- | INTERNAL_SERVER.md | 24 |
1 files changed, 12 insertions, 12 deletions
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 @@ | |||
2 | <img src="./src/internal-server/public/images/logo.png" alt="" width="300"/> | 2 | <img src="./src/internal-server/public/images/logo.png" alt="" width="300"/> |
3 | </p> | 3 | </p> |
4 | 4 | ||
5 | # ferdi-internal-server | 5 | # ferdium-internal-server |
6 | Internal Ferdi Server used for storing settings/preferences without logging into an external server. | 6 | Internal Ferdium Server used for storing settings/preferences without logging into an external server. |
7 | 7 | ||
8 | ## Differences to ferdi-server | 8 | ## Differences to ferdium-server |
9 | - Doesn't contain user management (only one user) | 9 | - Doesn't contain user management (only one user) |
10 | - Doesn't require logging in | 10 | - Doesn't require logging in |
11 | - No recipe creation | 11 | - No recipe creation |
12 | - Contains `start.js` script to allow starting the server via script | 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 | 13 | - Uses `env.ini` instead of `.env` to stay compatible with Ferdium's build script |
14 | - Only allows Ferdi clients to connect to the API | 14 | - Only allows Ferdium clients to connect to the API |
15 | 15 | ||
16 | ## Configuration | 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: | 17 | franz-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, ferdi-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 recipe library instead of only custom recipes |
20 | - Import Franz accounts | 20 | - Import Franz accounts |
21 | 21 | ||
22 | ## Importing your Franz account | 22 | ## Importing your Franz account |
23 | `ferdi-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 | ||
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. | 25 | 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. |
26 | 26 | ||
27 | ## Development | 27 | ## Development |
28 | 28 | ||
29 | You can locally develop `ferdi-internal-server` outside of Ferdi. | 29 | You can locally develop `ferdium-internal-server` outside of Ferdium. |
30 | 30 | ||
31 | 1. Start the local server via | 31 | 1. Start the local server via |
32 | ```bash | 32 | ```bash |
33 | npm run start:server | 33 | npm run start:server |
34 | ``` | 34 | ``` |
35 | 2. Change Ferdi's server to `http://localhost:45568` to start using the local test server. | 35 | 2. Change Ferdium's server to `http://localhost:45568` to start using the local test server. |
36 | 36 | ||
37 | ## Note For previous contributors | 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) | 38 | 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) |