Skip to content
This repository was archived by the owner on Sep 22, 2020. It is now read-only.

Commit 38f531a

Browse files
committed
update readme
1 parent df8c2af commit 38f531a

1 file changed

Lines changed: 24 additions & 18 deletions

File tree

README.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -19,23 +19,9 @@ This Python script is made for doing a complete backup of your Wordpress blog's
1919

2020
pip install mechanize
2121

22-
## With Docker
23-
24-
docker run --rm -it -v <local path>:/backups docker.io/skyplabs/wordpress-backup-data
25-
26-
The *local path* refers the folder on your host system where the backup file will be stored.
27-
28-
If you want to store the backup file in your current directory :
29-
30-
docker run --rm -it -v $(pwd):/backups docker.io/skyplabs/wordpress-backup-data
31-
32-
And if you want to specify some *options* :
33-
34-
docker run --rm -it -v $(pwd):/backups docker.io/skyplabs/wordpress-backup-data -d /backups <options>
35-
3622
## How to
3723

38-
usage: wp_backup_data.py [-h] [-u USER] [-p PASSWORD] [-P] [-a ADDRESS]
24+
usage: wp_backup_data.py [-h] [-u USER] [-p PASSWORD] [-P] [-O] [-a ADDRESS]
3925
[-d DIRECTORY] [--http] [--https]
4026
[--ignore-certificate] [-v]
4127

@@ -48,6 +34,7 @@ And if you want to specify some *options* :
4834
password to use
4935
-P, --prompt-for-password
5036
prompt for password to use
37+
-O, --prompt-for-otp prompt for Yubikey OTP to use
5138
-a ADDRESS, --address ADDRESS
5239
root address of the WordPress blog (examples:
5340
'blog.example.net' or '192.168.20.53')
@@ -58,11 +45,30 @@ And if you want to specify some *options* :
5845
--ignore-certificate ignore invalid certificates
5946
-v, --version show program's version number and exit
6047

61-
Example: ./wp_backup_data.py -a blog.example.net -u user -P
48+
Example: ./wp-backup-data.py -a blog.example.net -u user -P
49+
50+
## Yubikey OTP support
51+
52+
If you have secured your Wordpress blog with the [Yubikey OTP plugin][2], the *-O* option is made for you ! By this way, you will be prompted to enter your OTP.
53+
54+
## With Docker
55+
56+
docker run --rm -it -v <local path>:/backups docker.io/skyplabs/wordpress-backup-data
57+
58+
The *local path* refers the folder on your host system where the backup file will be stored.
59+
60+
If you want to store the backup file in your current directory :
61+
62+
docker run --rm -it -v $(pwd):/backups docker.io/skyplabs/wordpress-backup-data
63+
64+
And if you want to specify some *options* :
65+
66+
docker run --rm -it -v $(pwd):/backups docker.io/skyplabs/wordpress-backup-data -d /backups <options>
6267

6368
## License
6469

65-
[GPL version 3][2]
70+
[GPL version 3][3]
6671

6772
[1]: https://pypi.python.org/pypi/mechanize "Mechanize Python package"
68-
[2]: https://www.gnu.org/licenses/gpl.txt "GPL version 3"
73+
[2]: https://wordpress.org/plugins/yubikey-plugin/ "Yubikey Wordpress plugin"
74+
[3]: https://www.gnu.org/licenses/gpl.txt "GPL version 3"

0 commit comments

Comments
 (0)