infra/hedgedoc-migrator
2
0
Fork 0
Code Issues Pull requests Activity Actions

Cleaned up readme

Browse source
This commit is contained in:
Nick Hahn 2022-09-15 18:36:16 +02:00
parent 425b13d7a4
commit 226a9c4a38
1 changed files with 12 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -2,12 +2,20 @@
Simple script to migrate content from one Hedgedoc instance to another. Simple script to migrate content from one Hedgedoc instance to another.
## Setup ## Cypress
Follow the guide over [here](https://docs.cypress.io/guides/getting-started/installing-cypress#Linux-Prerequisites). Follow the guide over [here](https://docs.cypress.io/guides/getting-started/installing-cypress#Linux-Prerequisites).
You also require NodeJS. Run `npm ci` to install the required packages. You also require NodeJS. Run `npm ci` to install the required packages.
### Execution
To start cypress, simply execute `npx cypress open`. Then click `E2E Testing` and run using electron. This step could be automated using the `cypress` [API](https://docs.cypress.io/guides/guides/module-api).
## Python
Create new python venv: Create new python venv:
``` ```
python -m venv venv python -m venv venv
@ -21,12 +29,10 @@ source venv/bin/activate
Install the requirements Install the requirements
``` ```
pip -r requirements.txt pip install -r requirements.txt
``` ```
## Execution ### Execution
To start cypress, simply execute `npx cypress open`. Then click `E2E Testing` and run using electron. This step could be automated using the `cypress` [API](https://docs.cypress.io/guides/guides/module-api).
Start the extractor Start the extractor
``` ```
@ -38,7 +44,7 @@ For example:
python hedgedoc-image.py https://md.margau.net/dbk-meta pad.hacknang.de python hedgedoc-image.py https://md.margau.net/dbk-meta pad.hacknang.de
``` ```
## Produced files ### Produced files
The python scripts produces a `pads.json` which contains the mapping from `old_url` to `new_url`. The python scripts produces a `pads.json` which contains the mapping from `old_url` to `new_url`.
All images land in `images/uploads`. Only images hosted on the `old_pads` URL are saved All images land in `images/uploads`. Only images hosted on the `old_pads` URL are saved