penguinite
/
Forget-Me-Not
forked from ITwrxOrg/Forget-Me-Not
1
0
Fork 0
Code Pull Requests Activity

Update README.md

This commit is contained in:
ITwrx 2025-05-18 11:13:07 -05:00
parent 8ba825104a
commit 67bf568731
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -5,19 +5,29 @@ A single-user-per-instance web application for creating/editing Reminders that c
# System Package Dependencies # System Package Dependencies
curl: send any due Reminders by running the following Curl command from /etc/periodic/15min or similar cron mechanism. curl: send any due Reminders by running the following Curl command from /etc/periodic/15min or similar cron mechanism.
-- curl -d "send_reminders_key=your-string-key" -X POST http://127.0.0.1:your-apps-post-port-num/send-reminders -- curl -d "send_reminders_key=your-string-key" -X POST http://127.0.0.1:your-apps-post-port-num/send-reminders
-- set your send_reminders_key in /post_handlers/send_reminders_post_handler.nim -- set your send_reminders_key in /post_handlers/send_reminders_post_handler.nim
xmppc: Forget-Me-Not uses this program to send the XMPP messages. If you only ever intend to use email notifications then you don't need it. xmppc: Forget-Me-Not uses this program to send the XMPP messages. If you only ever intend to use email notifications then you don't need it.
libsodium: This is used to hash user passwords when creating a Forget-Me-Not user with /dev/create_user.nim. See comments in fmn_gs.nim. libsodium: This is used to hash user passwords when creating a Forget-Me-Not user with /dev/create_user.nim. See comments in fmn_gs.nim.
sqlite3: for the database. sqlite3: for the database.
nim: to compile binary. We used nim 2.2.4 at the time of writing this. nim: to compile binary. We used nim 2.2.4 at the time of writing this.
# Compiling and running # Compiling and running
-- Install any non std/lib Nim package dependencies imported in the Forget-Me-Not source code with Nimble. -- Install any non std/lib Nim package dependencies imported in the Forget-Me-Not source code with Nimble.
-- compile with `nim c --cc:clang --mm:atomicArc -d:ssl --d:release fmn_gs.nim`. Remove `--cc:clang` to use gcc instead. -- compile with `nim c --cc:clang --mm:atomicArc -d:ssl --d:release fmn_gs.nim`. Remove `--cc:clang` to use gcc instead.
-- automate starting with openrc, systemd, or similar. -- automate starting with openrc, systemd, or similar.
-- use nginx (or similar) as reverse proxy and for serving assets. -- use nginx (or similar) as reverse proxy and for serving assets.
-- we will try to add some example configs for some of this as time allows, assuming user interest. -- we will try to add some example configs for some of this as time allows, assuming user interest.
# Or use ITwrx web hosted instance. # Or use ITwrx web hosted instance.