diff options
| -rw-r--r-- | README.org | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/README.org b/README.org new file mode 100644 index 0000000..90b76d7 --- /dev/null +++ b/README.org @@ -0,0 +1,71 @@ +* ๐งต๐ Threadcat + /A radically simple, low feature, message board for shared *nix systems/ + +Why? Because its just 4 small shell scripts and some easy-to-do +directory config. + +** Basic Idea + + You post to threadcat using =cat= or =echo=. Here is an example: + + : cat <<EOF | threadcat write SomeThread + : + : Here is a message! + : It can be multiline! + : + : EOF + + Or you can post a short message with =echo=: + + : echo Just saying Hey | threadcat write SomeOtherThread + + You can the list and read messages with + + : threadcat list + + and + + : threadcat read SomeThread + + both of which print to standard out. + +** Install the client + +Assuming that =~/.local/bin= is in your =PATH=, just put the threadcat scripts there: + +#+begin_src shell + +git clone https://cicadas.surf/cgit/colin/threadcat.git threadcat +cd threadcat +cp *.sh ~/.local/bin +cp threadcat ~/.local/bin + +#+end_src + +That's all! Type =threadcat= at the command line to get started! + +** Server Setup + +#+begin_src shell + +ssh you@yourhost.com +sudo su + +#make a group +groupadd threadcat + +# add your users, group available on next login +usermod -a -G threadcat <user1> +usermod -a -G threadcat <user2> + +# make the threadcat directory +mkdir /opt/threadcat + +#and make it and its contents writable by threadcat group +chown root:threadcat /opt/threadcat +chmod g+rwxs /opt/threadcat + +#+end_src + +Thats it! + |