hedgedoc-expire/README.md

24 lines
1 KiB
Markdown

# hedgedoc-expire - remove old notes
A Python app that can be run regularly against a Postgres Hedgedoc database to remove old notes. Notes that are expired can be emailed to the author as a backup.
## Expiring old notes and revisions
Hedgedoc keeps notes and revisions (versions) of those notes forever. This might not be desirable, for example because of data protection reasons. With this utility, you can remove old revisions and old notes from the database.
### Expiring old revisions
All revisions that have been created before the specified age will be removed. If all revisions are older the newest revision that represents the current contents of the note will be retained.
## Local Development Setup
Use Docker Compose to bring up a local development environment.
* Hedgedoc: http://localhost:3000
* Adminer: http://localhost:8080/?pgsql=database&username=hedgedoc&db=hedgedoc&ns=public&password=geheim
You will need to create a user using the command line:
```sh
docker compose exec -it hedgedoc bin/manage_users --add foo@example.com --pass geheim
```