3217
Comment: Update OpenVPN information
|
3572
Minor formatting
|
Deletions are marked like this. | Additions are marked like this. |
Line 1: | Line 1: |
= Backups = | == Backups == |
Line 3: | Line 3: |
As of version 0.39, !FreedomBox now includes a Backups feature. The Backups feature is built using the "borgbackup" Debian package. Borg is a deduplicating and compressing backup program. It is designed for efficient and secure backups. This backups feature can be used to selectively backup data on an app-by-app basis. Thus, the Backups menu prompts users with a checklist of the apps whose data they want to backup. Users can select any number of apps to back up, from one to all. Note, however, that not all apps generate personal data, so not all apps will be listed in the backups menu. For your reference, the status report below lists the apps for which no backups are needed. | !FreedomBox includes the ability to backup and restore data, preferences, configuration and secrets from most of the applications. The Backups feature is built using Borg backup software. Borg is a deduplicating and compressing backup program. It is designed for efficient and secure backups. This backups feature can be used to selectively backup and restore data on an app-by-app basis. Backed up data can be stored on the !FreedomBox machine itself or on a remote server. Any remote server providing SSH access can be used as a backup storage repository for !FreedomBox backups. Data stored remotely may be encrypted and in such cases remote server cannot access your decrypted data. |
Line 5: | Line 5: |
As the Backups feature is currently still in development, it can only backup data for a limited number of !FreedomBox apps. We are working on offering backup support for every app in the !FreedomBox system. | |
Line 7: | Line 6: |
== Status Report for Backups Integration == | === Status of Backups Feature === |
Line 9: | Line 8: |
The following apps require no backups and therefore require no integration in the Backups feature: * Avahi (no backup needed) * Backups (no backup needed) * Cockpit (no backup needed) * Diagnostics (no backup needed) * Firewall (no backup needed) * JSXC (no backup needed) * Names (no backup needed) * Power (no backup needed) * Privoxy (no backup needed) * Roundcube (no backup needed) * SearX (no backup needed) * Storage (no backup needed) |
|| '''App/Feature''' || '''Support in Version''' || '''Notes''' || || Avahi || - || no backup needed || || Backups || - || no backup needed || || Bind || 0.41 || || || Cockpit || - || no backup needed || || Coquelicot || 0.40 || includes uploaded files || || Datetime || 0.41 || || || Deluge || 0.41 || does not include downloaded/seeding files || || Diagnostics || - || no backup needed || || Dynamic DNS || 0.39 || || || ejabberd || 0.39 || includes all data and configuration || || Firewall || - || no backup needed || || ikiwiki || 0.39 || includes all wikis/blogs and their content || || infinoted || 0.39 || includes all data and keys || || JSXC || - || no backup needed || || Let's Encrypt || 0.42 || || || Matrix Synapse || 0.39 || includes media and uploads || || !MediaWiki || 0.39 || includes wiki pages and uploaded files || || Minetest || 0.39 || || || Monkeysphere || 0.42 || || || Mumble || 0.40 || || || Names || - || no backup needed || || Networks || No || No plans currently to implement backup || || OpenVPN || 0.48 || includes all user and server keys || || Pagekite || 0.40 || || || Power || - || no backup needed || || Privoxy || - || no backup needed || || Quassel || 0.40 || includes users and logs || || Radicale || 0.39 || includes calendar and cards data for all users || || repro || 0.39 || includes all users, data and keys || || Roundcube || - || no backup needed || || SearX || - || no backup needed || || Secure Shell (SSH) Server || 0.41 || includes host keys || || Security || 0.41 || || || Shadowsocks || 0.40 || only secrets || || Sharing || 0.40 || does not include the data in the shared folders || || Snapshot || 0.41 || only configuration, does not include snapshot data || || Storage || - || no backup needed || || Syncthing || 0.48 || does not include data in the shared folders || || Tahoe-LAFS || 0.42 || includes all data and configuration || || Tiny Tiny RSS || Pending || || || Tor || 0.42 || includes configuration and secrets such as hidden service keys || || Transmission || 0.40 || does not include downloaded/seeding files || || Upgrades || 0.42 || || || Users || No || No plans currently to implement backup || |
Line 23: | Line 54: |
As of version 0.39, the following apps and features are supported by the Backups feature: * Dynamic DNS * ejabberd * ikiwiki * infinoted * Matrix Synapse * !MediaWiki * Minetest * Radicale * repro In version 0.40, the following apps and features are supported by the Backups feature: * Coquelicot * Mumble * Pagekite * Quassel * Shadowsocks * Sharing * Transmission In version 0.41, the following apps and features are supported by the Backups feature: * Bind * Deluge * Datetime * Secure Shell (SSH) Server * Security * Snapshot In version 0.42, the following apps and features are supported by the Backups feature: * Monkeysphere * Tahoe-LAFS * Tor * Upgrades * Let's Encrypt In version 0.48, the following apps and features will be supported by the Backups feature: * OpenVPN We are still working on Backups support for the following apps and features: * Syncthing * Tiny Tiny RSS There are no plans to backup data for the following application for now: * Networks * Users You can find an updated log of our progress here: https://salsa.debian.org/freedombox-team/plinth/issues/1390 == How to install and use Backups == |
=== How to install and use Backups === |
Backups
FreedomBox includes the ability to backup and restore data, preferences, configuration and secrets from most of the applications. The Backups feature is built using Borg backup software. Borg is a deduplicating and compressing backup program. It is designed for efficient and secure backups. This backups feature can be used to selectively backup and restore data on an app-by-app basis. Backed up data can be stored on the FreedomBox machine itself or on a remote server. Any remote server providing SSH access can be used as a backup storage repository for FreedomBox backups. Data stored remotely may be encrypted and in such cases remote server cannot access your decrypted data.
Status of Backups Feature
App/Feature |
Support in Version |
Notes |
Avahi |
- |
no backup needed |
Backups |
- |
no backup needed |
Bind |
0.41 |
|
Cockpit |
- |
no backup needed |
Coquelicot |
0.40 |
includes uploaded files |
Datetime |
0.41 |
|
Deluge |
0.41 |
does not include downloaded/seeding files |
Diagnostics |
- |
no backup needed |
Dynamic DNS |
0.39 |
|
ejabberd |
0.39 |
includes all data and configuration |
Firewall |
- |
no backup needed |
ikiwiki |
0.39 |
includes all wikis/blogs and their content |
infinoted |
0.39 |
includes all data and keys |
JSXC |
- |
no backup needed |
Let's Encrypt |
0.42 |
|
Matrix Synapse |
0.39 |
includes media and uploads |
MediaWiki |
0.39 |
includes wiki pages and uploaded files |
Minetest |
0.39 |
|
Monkeysphere |
0.42 |
|
Mumble |
0.40 |
|
Names |
- |
no backup needed |
Networks |
No |
No plans currently to implement backup |
OpenVPN |
0.48 |
includes all user and server keys |
Pagekite |
0.40 |
|
Power |
- |
no backup needed |
Privoxy |
- |
no backup needed |
Quassel |
0.40 |
includes users and logs |
Radicale |
0.39 |
includes calendar and cards data for all users |
repro |
0.39 |
includes all users, data and keys |
Roundcube |
- |
no backup needed |
SearX |
- |
no backup needed |
Secure Shell (SSH) Server |
0.41 |
includes host keys |
Security |
0.41 |
|
Shadowsocks |
0.40 |
only secrets |
Sharing |
0.40 |
does not include the data in the shared folders |
Snapshot |
0.41 |
only configuration, does not include snapshot data |
Storage |
- |
no backup needed |
Syncthing |
0.48 |
does not include data in the shared folders |
Tahoe-LAFS |
0.42 |
includes all data and configuration |
Tiny Tiny RSS |
Pending |
|
Tor |
0.42 |
includes configuration and secrets such as hidden service keys |
Transmission |
0.40 |
does not include downloaded/seeding files |
Upgrades |
0.42 |
|
Users |
No |
No plans currently to implement backup |
How to install and use Backups
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Step 7