README.md in imap-backup-2.1.0 vs README.md in imap-backup-2.1.1
- old
+ new
@@ -44,16 +44,17 @@
By default, all folders are backed-up. You can override this by choosing
specific folders.
## Configuration file
-`setup` creates ~/.imap-backup directory and configuration file. E.g.:
+`setup` creates the file `~/.imap-backup/config.json`
+E.g.:
+
```json
{
- "accounts":
- [
+ "accounts": [
{
"username": "my.user@gmail.com",
"password": "secret",
"local_path": "/path/to/backup/root",
"folders":
@@ -68,12 +69,11 @@
It connects to GMail by default, but you can also specify a server:
```json
{
- "accounts":
- [
+ "accounts": [
{
"username": "my.user@gmail.com",
"password": "secret",
"server": "my.imap.example.com",
"local_path": "/path/to/backup/root",
@@ -94,12 +94,11 @@
Specifically, if you are using a self-signed certificate and get SSL errors, e.g.
`certificate verify failed`, you can choose to not verify the TLS connection:
```json
{
- "accounts":
- [
+ "accounts": [
{
"username": "my.user@gmail.com",
"password": "secret",
"server": "my.imap.example.com",
"local_path": "/path/to/backup/root",
@@ -192,13 +191,10 @@
* Restartable - calculate start point based on already downloaded messages
* Standalone - do not rely on an email client or MTA
# Similar Software
-* https://github.com/thefloweringash/gmail-imap-backup
-* https://github.com/mleonhard/imapbackup
-* https://github.com/rgrove/larch - copies between IMAP servers
* https://github.com/OfflineIMAP/offlineimap
# Testing
## Integration Tests
@@ -215,21 +211,13 @@
--env MAILNAME=example.org \
--publish 8993:993 \
antespi/docker-imap-devel:latest
```
-Currently, the integration tests with Docker are excluded from the CI run.
+To exclude Docker-based tests:
-To run **just** the Docker-based tests:
-
-```
-rspec -t docker
-```
-
-To run **all** specs, including the integration tests, do the following:
-
-```
-rspec -O .rspec-all
+```sh
+$ rspec --tag ~docker
```
## Contributing
1. Fork it