Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 1.88 KB

INTERNAL_SERVER.md

File metadata and controls

38 lines (29 loc) · 1.88 KB
Raw

ferdi-internal-server

Internal Ferdi Server used for storing settings/preferences without logging into an external server.

Differences to ferdi-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

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:
    • 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.

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.

Development

You can locally develop ferdi-internal-server outside of Ferdi.

  1. Start the local server via
npm run start:server
  1. Change Ferdi'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