aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Vijay A <vraravam@users.noreply.github.com>2022-06-27 04:10:27 +0530
committerLibravatar Vijay A <vraravam@users.noreply.github.com>2022-06-27 04:10:28 +0530
commit1920ca8e1a16aeef79110c23b7a179a2abcd6ad4 (patch)
tree7ec38e5222a5f8bb4dda8c11e562a4d473e1f7e8
parentfeat: remember collapsed state of hamburger menu on refresh/reboot (#373) (diff)
downloadferdium-app-1920ca8e1a16aeef79110c23b7a179a2abcd6ad4.tar.gz
ferdium-app-1920ca8e1a16aeef79110c23b7a179a2abcd6ad4.tar.zst
ferdium-app-1920ca8e1a16aeef79110c23b7a179a2abcd6ad4.zip
Move the MIGRATION.md documentation from another repo [skip ci]
-rw-r--r--CONTRIBUTING.md3
-rw-r--r--MIGRATION.md38
-rw-r--r--README.md2
-rw-r--r--src/i18n/locales/en-US.json7
4 files changed, 40 insertions, 10 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0c53a5024..a58683fb5 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -39,8 +39,7 @@ Please report unacceptable behavior to [hello@ferdium.org](mailto:hello@ferdium.
39 39
40## What should I know before I get started? 40## What should I know before I get started?
41 41
42For the moment, Ferdium's development is only starting, aiming at releasing a 6.0.0 version with the rebranded assets and tooling upgrade completed. 42For the moment, Ferdium's development is only starting, aiming at releasing a 6.0.0 version with the rebranded assets and tooling upgrade completed. You can join our official [Discord chat](https://discord.com/invite/xpNTzgKmHM) to get more updates and discuss issues with the other contributors.
43You can join the Discord official chat here : https://discord.com/invite/xpNTzgKmHM.
44 43
45## How can I contribute? 44## How can I contribute?
46 45
diff --git a/MIGRATION.md b/MIGRATION.md
new file mode 100644
index 000000000..ee635b290
--- /dev/null
+++ b/MIGRATION.md
@@ -0,0 +1,38 @@
1# Migrating account data
2
3This 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
5Before 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
9The 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 ie Accountless
14
15Accountless 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.fedi-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
19Depending 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
211. Have Ferdi running on your system. (Even if you are on the initial "Get started" page, these instructions will work.)
222. Go to `Help > Import/Export Configuration Data` which should open the corresponding url in your default browser.
233. Click on `export your data to a ".ferdium-data" file`.
244. Save the `export.fedi-data` file to anywhere you'd like for safe-keeping/backup.
25
26## Importing
27
281. Have Ferdi running on your system.
292. 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.
303. Click on `import your data from a ".ferdium-data" file`.
314. Using the File browser button, find the previously saved `export.fedi-data` file on your system and click the "Import data" button.
325. Restart your application.
33
34_Note:_
35
361. 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.
372. 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.
383. 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).
diff --git a/README.md b/README.md
index 52510aa22..a757d3174 100644
--- a/README.md
+++ b/README.md
@@ -54,7 +54,7 @@ _Find answers to frequently asked questions on [ferdium.org/faq](https://ferdium
54 54
55## Migrating from Ferdi 55## Migrating from Ferdi
56 56
57If you are a pre-existing user of Ferdi, and are thinking of switching to Ferdium, you might want to run [the following scripts](./scripts/migration) to migrate your existing Ferdi profile such that Ferdium can pick up the configurations. (.ps1 for PowerShell/Windows users and .sh for UNIX (Linux and MacOS users) 57If you are a pre-existing user of Ferdi, and are thinking of switching to Ferdium, you might want to run [the following scripts](./scripts/migration) to migrate your existing Ferdi profile such that Ferdium can pick up the configurations. (.ps1 for PowerShell/Windows users and .sh for UNIX (Linux and MacOS users). For a more detailed explanation, please see [MIGRATION.md](MIGRATION.md)
58 58
59## Contributing 59## Contributing
60 60
diff --git a/src/i18n/locales/en-US.json b/src/i18n/locales/en-US.json
index f4871f207..a409c6f47 100644
--- a/src/i18n/locales/en-US.json
+++ b/src/i18n/locales/en-US.json
@@ -421,14 +421,7 @@
421 "setupAssistant.headline": "Let's get started", 421 "setupAssistant.headline": "Let's get started",
422 "setupAssistant.subheadline": "Choose from our most used services and get back on top of your messaging now.", 422 "setupAssistant.subheadline": "Choose from our most used services and get back on top of your messaging now.",
423 "setupAssistant.submit.label": "Let's go", 423 "setupAssistant.submit.label": "Let's go",
424 "sidebar.addNewService": "Add new service",
425 "sidebar.closeTodosDrawer": "Close Ferdium Todos",
426 "sidebar.closeWorkspaceDrawer": "Close workspace drawer",
427 "sidebar.lockFerdium": "Lock Ferdium",
428 "sidebar.muteApp": "Disable notifications & audio", 424 "sidebar.muteApp": "Disable notifications & audio",
429 "sidebar.openTodosDrawer": "Open Ferdium Todos",
430 "sidebar.openWorkspaceDrawer": "Open workspace drawer",
431 "sidebar.splitModeToggle": "Split Mode Toggle",
432 "sidebar.unmuteApp": "Enable notifications & audio", 425 "sidebar.unmuteApp": "Enable notifications & audio",
433 "signup.email.label": "Email address", 426 "signup.email.label": "Email address",
434 "signup.emailDuplicate": "A user with that email address already exists", 427 "signup.emailDuplicate": "A user with that email address already exists",