CCCHH/hedgedoc-expire
18
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Add a success indication
All checks were successful
docker-image / docker (push) Successful in 3m20s
Details

Browse source 
Also document the command.
This commit is contained in:
Stefan Bethke 2024-05-25 12:34:29 +02:00
parent 1fc917bdf5
commit 5fc42907e3
2 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -71,11 +71,12 @@ Without it, the expiry action will be taken.
Command is one of: Command is one of:
| Command | Description | | Command | Description |
|---------|------------------------------------------------------------------------------------------------------------| |------------|------------------------------------------------------------------------------------------------------------|
| check | Print a list of revisions and notes that would be expired, based on the given parameters for `-n` and `-r` | | check | Print a list of revisions and notes that would be expired, based on the given parameters for `-n` and `-r` |
| cron | Run `expire` at 2 am local time each day. Will run until killed. | | cron | Run `expire` at 2 am local time each day. Will run until killed. |
| expire | Expire old revisions and notes. | | emailcheck | Send a test email from the configured sender to themselves. |
| expire | Expire old revisions and notes. |
### Environment variables ### Environment variables

2
hedgedoc-expire.py
View file

@ -69,6 +69,7 @@ class EmailSender:
except Exception as e: except Exception as e:
print(f'Unable to send mail through {self}: {e}') print(f'Unable to send mail through {self}: {e}')
raise e raise e
print(f'Test email to {self.mail_from} sent successfully.')
def __str__(self): def __str__(self):
return f'EmailSender<{self.hostname},{self.port},{self.username},{self.mail_from}>' return f'EmailSender<{self.hostname},{self.port},{self.username},{self.mail_from}>'
@ -291,6 +292,7 @@ def main():
command is one of: command is one of:
- check: print a list of revisions and notes to be expired - check: print a list of revisions and notes to be expired
- cron: run expire every 24 hours - cron: run expire every 24 hours
- emailcheck: send a test email from the configured sender to themselves
- expire: expire old revisions and untouched notes - expire: expire old revisions and untouched notes
See https://git.hamburg.ccc.de/CCCHH/hedgedoc-expire See https://git.hamburg.ccc.de/CCCHH/hedgedoc-expire