generated from ITwrxOrg/EZ-Bkup
Compare commits
4 Commits
451492fa20
...
release-0.
| Author | SHA1 | Date | |
|---|---|---|---|
| 5ff6b0b993 | |||
| 67bf568731 | |||
| 8ba825104a | |||
| 44410f85f6 |
23
README.md
23
README.md
@@ -1,18 +1,35 @@
|
|||||||
# 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.
|
||||||
|
|
||||||
-- 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.
|
||||||
|
|
||||||
-- 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.
|
||||||
|
|||||||
Reference in New Issue
Block a user