diff options
author | 2023-03-15 17:26:13 +0100 | |
---|---|---|
committer | 2023-03-15 17:26:13 +0100 | |
commit | f1152d3dbb4c6deefea168d66f15f77b7155a5fe (patch) | |
tree | 22c27234b6e3a2dfe47ade037ece47b2533f7039 /MIGRATION.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 'MIGRATION.md')
-rw-r--r-- | MIGRATION.md | 38 |
1 files changed, 0 insertions, 38 deletions
diff --git a/MIGRATION.md b/MIGRATION.md deleted file mode 100644 index bb1ca315d..000000000 --- a/MIGRATION.md +++ /dev/null | |||
@@ -1,38 +0,0 @@ | |||
1 | # Migrating account data | ||
2 | |||
3 | This guide is here to show you how to export your current Ferdi setup from the online server or from an accountless session for safe-keeping, backup or transferring to a new instance using only a browser. | ||
4 | |||
5 | Before getting into the details of using an online account vs accountless, let's quickly review what the differences are between the two of them: | ||
6 | |||
7 | ## Using Ferdi with an Account | ||
8 | |||
9 | The main advantage of using Ferdi with an account is that you have your configuration data stored on a cloud - and thus, when moving to a different machine, once you login, all these configurations are applied to the Ferdi instance on your new machine. | ||
10 | |||
11 | **But**, if you use a Ferdi account, you need to reach their servers. If the servers are not accessible, you sadly have no other options for getting your data as there are no local copies. So it is advised to do this as soon as there's a chance - just to be safe. | ||
12 | |||
13 | ## Using Ferdi without an account i.e. Accountless | ||
14 | |||
15 | Accountless instances have all the same functionality as account-based ones with the exception of multi-machine syncronization. If you don't intend to use this app on multiple machines with regularly changing settings and lists of services, there's no benefit to having an online account. Having a backup of your `export.ferdi-data` whenever you make changes to your setup, provides a similarly secure (albeit slower and manual alternative) to automatic syncing that doesn't rely on a server's constant availability. | ||
16 | |||
17 | ## Exporting | ||
18 | |||
19 | Depending on where you have your account, you have to visit separate sites to retrieve it. This has no impact on your current instances. You can follow the next steps to access and export that data irrespective of which online server holds your data. | ||
20 | |||
21 | 1. Have Ferdi running on your system. (Even if you are on the initial "Get started" page, these instructions will work.) | ||
22 | 2. Go to `Help > Import/Export Configuration Data` which should open the corresponding url in your default browser. | ||
23 | 3. Click on `export your data to a ".ferdi-data" file`. | ||
24 | 4. Save the `export.ferdi-data` file to anywhere you'd like for safe-keeping/backup. | ||
25 | |||
26 | ## Importing | ||
27 | |||
28 | 1. Have Ferdium running on your system. | ||
29 | 2. When you get to the screen that says "Get Started", go to `Help > Import/Export Configuration Data` which should open a local url in your default browser. | ||
30 | 3. Click on `import your data from a ".ferdium-data" or ".ferdi-data" file`. | ||
31 | 4. Using the File browser button, find the previously saved `export.ferdi-data` file on your system and click the "Import data" button. | ||
32 | 5. Restart your application. | ||
33 | |||
34 | _Note:_ | ||
35 | |||
36 | 1. Setting up new instances or migrating to an accountless setup will require all services to be logged-in by hand again. This is because the session information only stays on your local machine - ever. | ||
37 | 2. Importing data does not override the list of local services if you have any, but adds them to the current list. This is normal behavior. If you do not want to deal with duplicate instances of services, you can delete your pre-existing services prior to importing from the previously exported data file. | ||
38 | 3. Due to current risks of losing access to Ferdi's services, it is ill-advised to use their servers in the future. You should setup your own server while you wait for official Ferdium solutions (if automatic syncing is important to you). | ||