first commit
This commit is contained in:
32
README.md
Normal file
32
README.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Bookstack Backup
|
||||
This Script works via the Bookstack API.
|
||||
You can decide which file Type you want to download, you can decide from text, markdown, pdf and html.
|
||||
## How it works
|
||||
You should have an Python virtual Environment and the pip package *bookstack* installed.
|
||||
If it's not installed, you can install it via:
|
||||
```
|
||||
python3 -m venv [Name of your venv Folder]
|
||||
source [Your Venv Folder]/bin/activate
|
||||
pip install bookstack
|
||||
```
|
||||
Now you can run the script:
|
||||
```
|
||||
python3 main.py
|
||||
```
|
||||
## How to get an API key
|
||||
##### Step 1:
|
||||
- Log in with an administrator account
|
||||
##### Step 2:
|
||||
- Click on settings in the top bar
|
||||
##### Step 3:
|
||||
- Go to the user tab
|
||||
##### Step 4:
|
||||
- Click on the user you want to create an API Token for
|
||||
##### Step 5:
|
||||
- Scroll down to API-Token
|
||||
##### Step 6:
|
||||
- Click on "Create Token"
|
||||
##### Step 7:
|
||||
- Give the token a name and expiry date
|
||||
##### Step 8:
|
||||
- Save your "Token ID" and "Token Secret"
|
||||
Reference in New Issue
Block a user