-
-
Notifications
You must be signed in to change notification settings - Fork 27
/
README.md
448 lines (330 loc) · 18.6 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
<p align="center">
<strong>
<a href="https://www.rdiffweb.org">website</a>
• <a href="https://www.ikus-soft.com/archive/rdiffweb/doc/latest/html/">docs</a>
• <a href="https://groups.google.com/d/forum/rdiffweb">community</a>
• <a href="https://rdiffweb-demo.ikus-soft.com/">demo</a>
</strong>
</p>
<p align="center">
<a href="LICENSE"><img alt="License" src="https://img.shields.io/github/license/ikus060/rdiffweb"></a>
<a href="https://gitlab.com/ikus-soft/rdiffweb/pipelines"><img alt="Build" src="https://gitlab.com/ikus-soft/rdiffweb/badges/master/pipeline.svg"></a>
<a href="https://sonar.ikus-soft.com/dashboard?id=rdiffweb"><img alt="Quality Gate Minarca Client" src="https://sonar.ikus-soft.com/api/project_badges/measure?project=rdiffweb&metric=alert_status"></a>
<a href="https://sonar.ikus-soft.com/dashboard?id=rdiffweb"><img alt="Coverage" src="https://sonar.ikus-soft.com/api/project_badges/measure?project=rdiffweb&metric=coverage"></a>
</p>
<h1 align="center">
Welcome to Rdiffweb
</h1>
Rdiffweb is a web application that allows you to view repositories generated
by [rdiff-backup](https://rdiff-backup.net/). The purpose of this
application is to ease the management of backups and quickly restore your data
with a rich and powerful web interface.
Rdiffweb is written in Python and is released as open source project under the
GNU GENERAL PUBLIC LICENSE (GPL). All source code and documentation are
Copyright Rdiffweb contributors.
Rdiffweb is actively developed by [IKUS Soft](https://www.ikus-soft.com/)
since November 2014.
The Rdiffweb source code is hosted on [Gitlab](https://gitlab.com/ikus-soft/rdiffweb)
and mirrored to [Github](https://github.com/ikus060/rdiffweb).
The Rdiffweb website is https://rdiffweb.org/.
## Features
With its rich web interface Rdiffweb provide a notable list of features:
* Browse your backup
* Restore single file or multiple files as an archived
* Users authentication via local database and LDAP
* Users authorization
* Email notification when backup is not successful
* Configurable repository encoding
* Configurable retention period
* Backup statistics visualization using graphs
* SSH Keys management
* Disk quota visualization
* File and folder deletion
## Demo
If you quickly want to check how Rdiffweb is behaving, you may try our demo server hosted on:
[https://rdiffweb-demo.ikus-soft.com/](https://rdiffweb-demo.ikus-soft.com/)
Use the following credential to login:
* Username: admin
* Password: admin123
## Installation & Docker usage
For detailed installation steps, read the [Installation documentation](https://www.ikus-soft.com/archive/rdiffweb/doc/latest/html/installation.html).
## Current Build Status
[](https://gitlab.com/ikus-soft/rdiffweb/pipelines)
## Download
You should read the [Documentation](https://www.ikus-soft.com/archive/rdiffweb/doc/latest/html/index.html) to properly install Rdiffweb in your environment.
**Docker**
docker pull ikus060/rdiffweb
**Debian**
curl -L https://www.ikus-soft.com/archive/rdiffweb/public.key | apt-key add -
echo "deb https://nexus.ikus-soft.com/repository/apt-release-bullseye/ bullseye main" > /etc/apt/sources.list.d/rdiffweb.list
apt update
apt install rdiffweb
**Pypi**
pip install rdiffweb
## Support
### Mailing list
Rdiffweb users should use the [Rdiffweb mailing list](https://groups.google.com/forum/#!forum/rdiffweb).
### Bug Reports
Bug reports should be reported on the Rdiffweb Gitlab at https://gitlab.com/ikus-soft/rdiffweb/-/issues
### Professional support
Professional support for Rdiffweb is available by contacting [IKUS Soft](https://www.ikus-soft.com/en/support/#form).
# Changelog
## Next Release - 2.5.0
This next release focus on multi-factor-authentication as a measure to increase security of user's account.
* Store User's session information into database
* Update ldap plugin to load additional attributes from LDAP server
* Improve `/status` page error handling when `session_statistics` cannot be read
* Add support for Ubuntu Jammy
* Upgrade from Bootstrap v3 to v4 #204
* Replace Fontello by Font-Awesome v4
* Use CSS variables `var()` to customize themes
* Remove usage of Jquery.validate
* Replace custom timsort by jquery DataTables #205
* Add Active Session managements #203
* Active session should be visible in user's profiles
* Active session may be revoked by user
* Active session should be visible in administration view
* Action session may be revoke by administrator
* Show number of active users within the last 24 hours in dashboard
* Handle migration of older Rdiffweb database by adding the missing `repos.Encoding`, `repos.keepdays` and `users.role` columns #185
* Replace deprecated references of `disutils.spawn.find_executable()` by `shutil.which()` #208
Breaking changes:
* Drop Ubuntu Hirsute & Impish (End-of-life)
* `session-dir` is deprecated and should be replace by `rate-limit-dir`. User's session are stored in database.
* previous `.css` customization are not barkward compatible
## 2.4.3 (2022-09-14)
This releases include a security fix. If you are using an earlier version, you should upgrade to this release immediately.
* Mitigate CSRF in profile's SSH Keys #212
## 2.4.2 (2022-09-12)
This releases include a security fix. If you are using an earlier version, you should upgrade to this release immediately.
* Use 'Secure' Attribute with Sensitive Cookie in HTTPS Session. [CVE-2022-3174](https://nvd.nist.gov/vuln/detail/CVE-2022-3174) #209
* Avoid leakage of the stack trace in the default error page. [CVE-2022-3175](https://nvd.nist.gov/vuln/detail/CVE-2022-3175) #210
* Enforce minimum and maximum password length [CVE-2022-3175](https://nvd.nist.gov/vuln/detail/CVE-2022-3179) #211
## 2.4.1 (2022-09-08)
This releases include a security fix. If you are using an earlier version, you should upgrade to this release immediately.
* Add Clickjacking Defense [CVE-2022-3167](https://nvd.nist.gov/vuln/detail/CVE-2022-3167)
* Drop Ubuntu Hirsute & Impish (End-of-life)
## 2.4.0 (2022-06-21)
This new release brings a lot of improvement since the last version, multiple bug fixes
to make the application stable. A couple of new features to improve the overall
usability and a new security feature to block a brute force attack.
* Add RateLimit to login page and API to mitigate robots attacks #167
* Send email notification only if `email-sender` option is defined to avoid raising exception in logs #176
* Support file restore cancellation without leaving `rdiffweb-restore` process in `<defunct>` state #174
* Replace `python-ldap` by `ldap3` a pure python implementation to avoid dependencies on `sasl` and `ldap` binaries #186
* Reffactor core module to allow better extendability and reusability #183
* Add support for Debian Bookworm #180
* Add support for Ubuntu Impish #175
* Add rdiff-backup version to administration view
* Run unit test during Debian build package
* Refresh repository list automatically when required #188 #189
* Fix error 500 displayed in status page #191
* Improve repository browsing speed by minimizing the number of I/O call #192
* Publish Docker image directly to DockerHub #144
Breaking changes:
* Ldap Password changes is not supported anymore.
* Ldap Check Shadow expire config is not supported anymore. It should be replace by a custom filter.
* Drop CentOS 7 and CentOS 8 support
## 2.3.9 (2022-01-05)
Maintenance release to fix minor issues
* Improve date parsing for `backup.log` to avoid printing exception in logs #170
* Return HTTP error 403 for invalid symlink to avoid returning a misleading HTTP 500 Server Error #168
* Show a user friendly error message when trying to create a new user with an existing username #169
* Handle repository without last-backup date during the notification process to ensure notifications are sent #171
* Replace CherryPy `storage_type` by `storage_class` to avoid warning in logs
* Update code to avoid deprecation warning where applicable
* Add Flake8 validation to improve code quality
* Remove Ubuntu Groovy support
## 2.3.8 (2021-12-01)
* Push all artefacts to nexus server including binaries and documentation
* Fix `Chart.js` loading on Debian bullseye #164
* Update installation steps documentation
* Improve LDAP authentication to lookup entire directory
* Fix usage of `--ldap-add-user-default-userroot` to avoid error related to wrong encoding
* Improve authentication mechanics
* Avoid raising an HTTP error 500 when login form receive invalid payload
* Mitigate open redirect vulnerability in login form
## 2.3.7 (2021-10-21)
* To avoid backward compatibility issue, revert CSRF Token validation
* Mitigate CSRF vulnerability using cookies with `SameSite=Lax`
* Mitigate CSRF vulnerability by validating the `Origin` header when a form is submited
* Improve usage of WTForm for all form validation
* Update installation stepd for debian #162
* Build Ubuntu packages and publish them to our APT repo
## 2.3.6 (2021-10-20)
* Broken build
## 2.3.5 (2021-10-18)
* Mitigate CSRF vulnerability to user, ssh and repo management with CSRF Token
## 2.3.4 (2021-09-20)
* Skip email notification if `email-host` configuration is not provided #157
* Skip email notification when the new attribute value has the same value #159
* USE LDAP `mail` attribute when creating new user from LDAP directory #156
## 2.3.3 (2021-09-10)
* Provide a new theme `blue` to match IKUS Soft colors #158
## 2.3.2 (2021-09-07)
* Automatically update user's repository list based on user's home directory
## 2.3.1 (2021-07-14)
* Update default `session-dir` location to `/var/lib/rdiffweb/session` to avoid using `/var/run` #148
## 2.3.0 (2021-07-06)
* Improve timezone handling to display date with local timezone using javascript #143
* Improve charts by replacing d3js by chartkick #122
* Replace the status view by something meaningful with chartkick #122
* Provide Docker image with Rdiffweb `docker pull ikus060/rdiffweb` #55
* Fix file and folder sorting #143
## 2.2.0 (2021-05-11)
* Debian package:
* Add rdiff-backup as dependencies to comply with Debian packaging rules
* Multiple other fixed to control files
* Use debhelper-compat (= 13)
* Use debhelper-compat (= 13)
* Run test during packaging
* Create default folder `/var/run/rdiffweb/sessions` to store user session
* Use ConfigArgPare for configuration to support configuration file, environment variables and arguments to configure rdiffweb #114
* Fix cache in localization module
* Add `ldap-add-default-role` and `ldap-add-default-userroot` option to define default value for role and user root when creating user from LDAP #125
* Support PostgreSQL database by replacing our storage layer by SQLAlchemy #126
* Fix to retrieve user quota only for valid user_root #135
* Add option `disable-ssh-keys` to disable SSH Key management
* Use absolute URL everywhere
* Add support for `X-Forward-For`, `X-Forward-proto` and other reverse proxy header when generating absolute URL
* Drop Debian Stretch support
* Implement a new background scheduler using apscheduler #82
* Use background job to send email notification to avoid blocking web page loading #47
* Use background job to delete repository to avoid blocking web page loading #48
* Allow deleting a specific file or folder from the history using `rdiff-backup-delete` #128
* Improve support for `session-dir` #131
* Add option `admin-password` to define administrator password for better security
* Improve performance of repository browsing
* Add a new view to display logs of a specific repository
* Allow downloading the log
* Define a default limit to graph statistics to make it display faster
* Fix `get-quota-cmd` option to properly return a value
## 2.1.0 (2021-01-15)
* Debian package: Remove dh-systemd from Debian build dependencies (https://bugs.debian.org/871312we)
* Improve Quota management:
* `QuotaSetCmd`, `QuotaGetCmd` and `QuotaUsedCmd` options could be used to customize how to set the quota for your environment.
* Display user's quota in User View
* Display user's quota in Admin View
* Allow admin to update user quota from Admin View when `QuotaSetCmd` is defined.
* Allow admin to define user quota using human readable value (e.g.: GiB, TiB, etc.)
* Improve logging around quota management
* Improve robustness when service is starting
* Improve robustness when repository has wrong permission defined (e.g.: when some files not readable)
* Add user id in Admin view
* Replace `UserObject(1)` by the actual username in log file to improve debugging
## 2.0.0 (2020-12-04)
* Re-implement logic to update repositories views to remove duplicates and avoid nesting repo. #107
* Handle elapsed time of days in the graph. Thanks [Nathaniel van Diepen](https://github.com/Eeems) contributions.
* Rebrand all link to ikus-soft.com
* Update documentation to install rdiffweb
* Remove obsolete minify dependency
* Drop support for python2
* Provide null translation if translation catalogues are not found
* Pass a LANG environment variable to rdiff-backup restore process to fix encoding issue #112
* Remove obsolete python shebang
* Remove execution bit (+x) on python modules
* Provide `--help` and `--version` on `rdiffweb` executable
* Improve cherrypy version detection
* Do not update translation files (.mo) during build
## 1.5.0 (2020-06-24)
This minor release introduce official support of rdiffweb on Debian Bullseye. It also includes some usability improvements.
* Change formatting of Last Backup date for "Updated 3 weeks ago" to ease the readability
* Add support for Debian Bullseye
* Add support for Python 3.8 (#104)
* Add warning in the users list view when a root directory is invalid (#30)
* Add options to control search depthness (#1)
* Print a warning in the log when the "DefaultTheme" value is not valid (#90)
## 1.4.0 (2020-05-20)
Thanks to our sponsor, this release introduce a feature to have better control over the user's permission by defining 3 different levels of privilege: Admin, Maintainer and User. This addition allows you to have better control on what your users can or can't do.
* Fix single repository discovery when a user's home is a rdiff-backup repository
* [SPONSORED] Add a new setting at the user level to define the user's role. Admin,
Maintainer and User. Admin are allowed to do everything. Maintainer are
allow to browse and delete repo. Users are only allowed to browse. #94
* Add "Powered by" in the web interface footer #91
* Display a nice error message when trying to delete admin user #93
* Introduce usage of wtforms and flash in admin users for better form validation. #96 #97
* Update French translation
## 1.3.2 (2020-04-23)
This minor releases fixed issues found while testing release 1.3.0.
* Fix lookup of executable rdiff-backup and rdiffweb-restore to search in current virtualenv first
* Fix repository view when multiple repo path are conflicting
* Fix logging of rdiffweb-restore subprocess
## 1.3.1 (2020-04-10)
This minor release enforces security of the password stored in rdiffweb database to make use of a better encryption using SSHA.
Only new passwords will make use of the SSHA scheme.
* Enforce password encryption by using SSHA scheme #88
## 1.3.0 (2020-04-07)
This release focuses on improving the restore of big archives. The download should be much faster to start. Major enhancement was made to offload the processing outside the web server. And all of this is still compatible with rdiff-backup v1.2.8 and the latest v2.0.0.
* Restore file and folder in a subprocess to make the download start faster
* Fix encoding of archive on Python3.6 (CentOS 7) by using PAX format
* Add support to restore files and folders using rdiff-backup2
* Remove obsolete dependencies `pysqlite2`
* Fix issue creating duplicate entries of repository in the database
## 1.2.2 (2020-03-05)
This release provides little improvement to the v1.2.x including official support of rdiff-backup v2.0.0.
* Enhance the repository to invite users to refresh the repository when the view is empty.
* Support rdiff-backup v2.0.0
* Deprecate support for cherrypy 4, 5, 6 and 7
* Improve loading of repository data (cache status and entries)
* Restore compatibility with SQLite 3.7 (CentOS7)
Known issues:
* Filename encoding in tar.gz and zip file might not be accurate if you are running Python 3.6 (CentOS7)
## 1.2.1 (2020-02-08)
Little bug fix following the previous release
* Fix 404 error when trying to access other users repo as admin
* Fix logging format for cherrypy logs to matches rdiffweb format
* Add log rotation by default
## 1.2.0 (2020-01-30)
This release focus on improving the database layers for better extendability to add more type of data and to support more databases backend like postgresql in the near future.
* Add explicit testing for Debian Stretch & Buster
* Change the persistence layers
* Minimize number of SQL queries
* Add object lazy loading
* Add object data caching
* Fix bugs with SQLite <= 3.16 (Debian Stretch)
## 1.1.0 (2019-10-31)
This release focus on improving the admin area and building the fundation for repository access control list (ACL).
* Update documentation from PDSL web site
* Improve the navigation bar layout
* Update the login page headline
* Update jinja2 version to allow 2.10.x
* Show server log in admin area
* Reduce code smell
* Add System information in admin area
* Validate credential using local database before LDAP
* Reffactoring templates macros
* Enhance user's view search bar
* Change repository URL to username/repopath
* Add System information in admin area
* Improve testcases
* Clean-up obsolete code
* Fix issue with captital case encoding name
* Fix compilation of less files
* Fix google font import
## 1.0.3 (2019-10-04)
* Removing the auto update repos
## 1.0.2 (2019-10-01)
* Create "admin" user if missing
* Update french translation
## 1.0.1 (2019-09-22)
* Update installation documentation
* Fix removal of SSH Key
* Return meaningful error to the user trying to add an existing SSH key
## 1.0.0 (2019-09-11)
* Make repository removal more robust
* Improve performance of librdiff
* Add new RESTful api
* Return the right HTTP 401 or 402 error code for authentication
* Fix bug introduce by upgrade to Jinja2 + python3
* Store ssh keys in database and disk
* Add support for theme (default, orange)
* Remove deprecated profiling code
* Add disk usage support / quota
* Add support of cherrypy v18
* Drop support of cherrypy v3.2.2
* Add wsgi entry point
* Replace the plugins architecture to ease implementation
* Numerous bug fixes
## 0.10.9 (2019-05-22)
* Better error handling when error.log file are not valid gzip file