From f1152d3dbb4c6deefea168d66f15f77b7155a5fe Mon Sep 17 00:00:00 2001 From: Kristóf Marussy Date: Wed, 15 Mar 2023 17:26:13 +0100 Subject: Basic D-Bus API (#866) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: basic D-Bus API Expose muted state and the number of unread message over D-Bus when running on Linux. This is useful for, e.g., displaying notifications on a window manager status bar. Signed-off-by: Kristóf Marussy * docs: create docs directory Move the documentation to a separate directory so that new documentation can be added into one place. We keep the following files still in the repository root by convention: * CHANGELOG.md * CODE_OF_CONDUCT.md * CONTRIBUTING.md * LICENSE.md * README.md * SECURITY.md Signed-off-by: Kristóf Marussy * docs: D-Bus usage example Signed-off-by: Kristóf Marussy * fix: remove unneeded D-Bus signals Only notify clients that the message counts or the mute status has changed if there actually was a change. Signed-off-by: Kristóf Marussy * docs: rewrite sample bar client * docs: better unread --services help * docs: update dbus docs * docs: use ferdium-dbus in dbus bar example * docs: make command argument required in bar example --------- Signed-off-by: Kristóf Marussy Co-authored-by: Victor Bonnelle --- docs/INTERNAL_SERVER.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 docs/INTERNAL_SERVER.md (limited to 'docs/INTERNAL_SERVER.md') diff --git a/docs/INTERNAL_SERVER.md b/docs/INTERNAL_SERVER.md new file mode 100644 index 000000000..9e94f9bdf --- /dev/null +++ b/docs/INTERNAL_SERVER.md @@ -0,0 +1,28 @@ +

+ +

+ +# ferdium-internal-server +Internal Ferdium Server used for storing settings/preferences without logging into an external 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 Ferdium's build script +- Only allows Ferdium clients to connect to the API + +## Configuration +`ferdium-internal-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/Ferdi recipe library instead of only custom recipes + - Import Franz/Ferdi accounts + +## Exporting backups +Since the `ferdium-internal-server` runs a local server, there's no automatic syncing of settings possible. You can backup your settings, by clicking on `Help > Import/Export Configuration Data` which will open the running server page in your browser. Choose the option to export and save the generated file. + +## Importing your Franz/Ferdi account +`ferdium-internal-server` allows you to import your full Franz account, including all its settings. + +To 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. -- cgit v1.2.3-70-g09d2