diff options
author | 2023-03-15 17:26:13 +0100 | |
---|---|---|
committer | 2023-03-15 17:26:13 +0100 | |
commit | f1152d3dbb4c6deefea168d66f15f77b7155a5fe (patch) | |
tree | 22c27234b6e3a2dfe47ade037ece47b2533f7039 /INTERNAL_SERVER.md | |
parent | 6.2.6-nightly.5 [skip ci] (diff) | |
download | ferdium-app-f1152d3dbb4c6deefea168d66f15f77b7155a5fe.tar.gz ferdium-app-f1152d3dbb4c6deefea168d66f15f77b7155a5fe.tar.zst ferdium-app-f1152d3dbb4c6deefea168d66f15f77b7155a5fe.zip |
Basic D-Bus API (#866)
* 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 <kristof@marussy.com>
* 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 <kristof@marussy.com>
* docs: D-Bus usage example
Signed-off-by: Kristóf Marussy <kristof@marussy.com>
* 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 <kristof@marussy.com>
* 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 <kristof@marussy.com>
Co-authored-by: Victor Bonnelle <victor.bonnelle@protonmail.com>
Diffstat (limited to 'INTERNAL_SERVER.md')
-rw-r--r-- | INTERNAL_SERVER.md | 28 |
1 files changed, 0 insertions, 28 deletions
diff --git a/INTERNAL_SERVER.md b/INTERNAL_SERVER.md deleted file mode 100644 index 1a1284f7e..000000000 --- a/INTERNAL_SERVER.md +++ /dev/null | |||
@@ -1,28 +0,0 @@ | |||
1 | <p align="center"> | ||
2 | <img src="./src/internal-server/public/images/logo.png" alt="" width="300"/> | ||
3 | </p> | ||
4 | |||
5 | # ferdium-internal-server | ||
6 | Internal Ferdium Server used for storing settings/preferences without logging into an external server. | ||
7 | |||
8 | ## Differences to ferdium-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 Ferdium's build script | ||
14 | - Only allows Ferdium clients to connect to the API | ||
15 | |||
16 | ## Configuration | ||
17 | `ferdium-internal-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, `ferdium-internal-server` can: | ||
19 | - Show the full Franz/Ferdi recipe library instead of only custom recipes | ||
20 | - Import Franz/Ferdi accounts | ||
21 | |||
22 | ## Exporting backups | ||
23 | 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. | ||
24 | |||
25 | ## Importing your Franz/Ferdi account | ||
26 | `ferdium-internal-server` allows you to import your full Franz account, including all its settings. | ||
27 | |||
28 | 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. | ||