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:11:58 -05:00
parent 44410f85f6
commit 8ba825104a
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -1,6 +1,7 @@
# Forget-Me-Not # Forget-Me-Not
A single-user-per-instance web application for creating/editing Reminders that can repeat in various ways. Supports email and XMPP notifications. It is written in [Nim](https://nim-lng.org) using the [Guildenstern](https://github.com/olliNiinivaara/GuildenStern) multi-threaded server library and the muti-threaded [SQLiteral](https://github.com/olliNiinivaara/SQLiteral) SQLite API library. A single-user-per-instance web application for creating/editing Reminders that can repeat in various ways. Supports email and XMPP notifications. It is written in [Nim](https://nim-lng.org) using the [Guildenstern](https://github.com/olliNiinivaara/GuildenStern) multi-threaded server library and the muti-threaded [SQLiteral](https://github.com/olliNiinivaara/SQLiteral) SQLite API library.
# 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.
@ -10,6 +11,7 @@ xmppc: Forget-Me-Not uses this program to send the XMPP messages. If you only ev
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.
@ -17,6 +19,7 @@ nim: to compile binary. We used nim 2.2.4 at the time of writing this.
-- 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.
-- We will add a Forget-Me-Not project page to ITwrx.org along with hosting plan. -- We will add a Forget-Me-Not project page to ITwrx.org along with hosting plan.