CIWIKI(1)

✨ CIWIKI ✨

okay bestie, so ciwiki is a General Commands Manual girlie and she's about to change your whole notes situation 💅

---

🌸 NAME 🌸

ciwiki — a simple wiki implementation with a built-in webserver. yes, built-in. no extra drama required 🫶

---

🎀 SYNOPSIS 🎀

ciwiki [options]

that's it. that's the whole vibe. options only, she doesn't want your attitude 🙈

---

💖 DESCRIPTION 💖

so ciwiki is for anyone who needs a quick and lightweight wiki for personal use — think notes, "to do" lists, that kind of thing ✨ She's written in C, and her system requirements are lowkey nonexistent: the binary size is ~73k stripped when you build with ./configure CFLAGS='-s -Os'. which means she absolutely ate on low-power systems like a Raspberry Pi 👑

and here's the iconic part: ciwiki does not require installation of a separate webserver, scripting language, or database. none. zero. she's self-sufficient. main character energy fr fr 💅

wanna change how the wiki pages look? drop a styles.css in ~/.ciwiki, or in whatever directory you set with the --home option. cute AND customizable 🌈

---

💅 OPTIONS 💅

• --log-less — suppresses non-critical syslog output (like logging page visits). for when you want her to stop narrating every little thing 😭
• -d, --debug — starts in debug mode. in this case, ciwiki will not bind to any IP address or port: she will only read the requests from standard input (stdin). soft launch mode, no cap 🦋
• -h directory, --home=directory — by default ciwiki stores its pages in ~/.ciwiki. you can override this by specifying an alternative directory. new home, new me 💖
• -l ipaddr, --listen=ipaddr — by default ciwiki binds to "0.0.0.0". you can override this by specifying an alternative IP address. choose your own address, icon behavior ✨
• -p port, --port=port — by default ciwiki will listen on port 8000. you can override this by specifying an alternative port. port 8000 is so default-coded, pick something else if you want 👑
• -a, --autologin — the localhost is logged automatically. no typing your little password, she just knows you 🫶
• -n, --nologin — no login, all user can modify the wiki. open doors, open heart, everybody gets edit access. chaotic but valid 💀
• -s, --sendmail — runs notifynewuser.sh. validation code, login and password are sent via email. ssmtp must be installed. no ssmtp, no email, no entry 😭
• -i length, --index=length — number of links to display in each box of the index page. curate your grid, bestie 🎀
• -u, --unmasked — default: the password is masked. --unmasked allows to show it. peek behind the curtain if you must 🙈
• -v, --version — prints the ciwiki version number. she'll tell you who she is 💅
• --help — display the help message. ask and you shall receive ✨

so to notify new users via email of their validation code, login and password, you need ssmtp (yes it's spelled ssmpt in places, we don't talk about it 😭) and the script notifynewuser.sh. that script is included in the package and should be located in the folder /usr/local/libexec. and listen: if you do not use the default port 8000, you will have to edit notifynewuser.sh line #25 to provide the actual port number. yes, line #25. literally go find it. don't skip this step, bestie, or the emails will simply not find their way home 💀

---

🔥 EXAMPLES 🔥

ciwiki uses syslog to log when it is launched or stopped, and when a page is accessed or modified. so if you wanna stalk her activity, here's how to list ciwiki logs:

$ grep Ciwiki /var/log/syslog

and in order to launch ciwiki on a specific IP and port:

$ ciwiki -l 127.0.0.1 -p 8080

look at her go. custom IP, custom port, thriving 🌟

---

🌈 AUTHOR 🌈

ciwiki by Jean-Pierre Redonnet <mallum@o-hand.com>. and plot twist for the lore girlies: ciwiki is a fork of didiwiki (written by Matthew Allum). we love a respectful lineage 💜

---

and that's the whole page, angel 🫶 — this was ciwiki 3.0.5, dated 2024-11-02, from the General Commands Manual section 1. go build something cute with her. periodt 💅✨