added readme

This commit is contained in:
James Tomasino 2018-11-27 14:21:15 -05:00
parent daa857e6b9
commit b1a516582e
3 changed files with 28 additions and 1 deletions

27
README.md Normal file
View File

@ -0,0 +1,27 @@
# cosmic.voyage scripts
## bin
### Administration
- `cosmic-backup` cron-run backup of /var/gopher to git repo
- `cosmic-rss` cron-run creation of rss feed for web and gopher
- `cosmic-ship` create a new ship and assign it to a given user
- `cosmic-user` create a new user and scaffold them into the story
- `cosmic-web` cron-run creation of html version of the story
### User
- `cosmic-log` aliased as `log` - submit messages to the QEC relay
- `cosmic-roster` aliased as `roster` - show current users and their ships
- `cosmic-motd` aliased as `motd` - pretty-prints the motd
## files
- `motd` message of the day, records recent updates to the system
## templates
- `web-header.tmpl` - template for web generation
- `newship.tmpl` - email template for adding new ship for user
- `welcomeemail.tmpl` - email template for new users added to system

View File

@ -6,7 +6,7 @@ if [ "$run_user" -eq 0 ]; then
SCRIPTPATH=$(dirname "$SCRIPT")
file_html="/var/www/html/index.html"
web_header_html="${SCRIPTPATH}/../files/web-header.tmpl"
web_header_html="${SCRIPTPATH}/../templates/webheader.tmpl"
ships_html="/var/www/html/ships/index.html"
error_html="/var/www/html/error.html"
html_dir="/var/www/html"