june/hedgedoc-expire
0
0
Fork 0
forked from CCCHH/hedgedoc-expire
Code Pull requests Activity

Small improvements

Browse source
This commit is contained in:
Stefan Bethke 2024-05-19 00:34:36 +02:00
commit b74873ae23
2 changed files with 15 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -10,10 +10,15 @@ of data protection reasons. With this utility, you can remove old revisions and
### 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.
All revisions that have been created before the specified age will be removed. If all revisions are expired, the note remains available, it just won't have any revisions to revert to. Once you continue editing it, new revisions will be added.
## Running hedgedoc-expire.py
### Expiring old notes
Notes that are being expired will be emailed to the account that initially created the note. This allows that user to restore the note, if necessary. Expiring a note will also remove all existing revisions for the note.
You will need to configure your environment for the `hedgedoc-expire` to be able to send mail. If the mail is not accepted by the mail server, the note will not be removed.
## Running `hedgedoc-expire.py`
Locally from the command line:
@ -26,7 +31,7 @@ From Docker Compose:
```yaml
hedgedoc-expire:
image: hedgedoc-expire
command: "-c -r .001 -n .001"
command: "-c -r 14 -n 95"
environment:
- "POSTGRES_HOSTNAME=database"
depends_on: