Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 2.92 KB

README.md

File metadata and controls

58 lines (39 loc) · 2.92 KB
Raw

THIS

fork is no longer maintained. For the most up-to-date version, go to https://github.com/einchan/sshchan and check out the oop branch (which should be merged into master sometime in the future).

I will leave this repository up to serve as a signpost to point to the original repository. IT WILL NOT BE UPDATED.

sshchan-oop

This is a fork of sshchan from http://neetco.de/chibi/sshchan, originally developed by chibi with my contributions. I wanted to refactor the code into an object-oriented approach, and so this repository was created.

A textboard environment implemented in Python. At the moment it is a script meant to be run server-side by a user connecting to that server using ssh. It hopes to be configurable and secure.

Status / Warning

sshchan is kind of usable as of now. Run setup.py to create needed directories and files and then sshchan.py to browse / administer the boards.

gui status

We were working on a curses gui in gui.py but there have been problems and development on that has temporarily stopped. If you want to try out sshchan, run sshchan.py instead. Urwid library seems like an option since it's nicer to use than plain curses Python module.

How to Install / Dependencies

git clone https://github.com/makos/sshchan-oop.git
cd sshchan-oop
python3 setup.py

That should set up the basic chan for you. From there, read the documentation docs/setup.md for more admin stuff.

Scripts

There are several scripts in sshchan:

  • sshchan.py is the user script for reading from/posting to the chan.
  • setup.py is the script the admin runs to set up a new chan.

How to use

When it becomes usable, sshchan will be a full script that emulates a textboard based on the files provided by the server, which acts as the chan operator. The main usage scenario is that users log into an anonymous user account on the chan operator's ssh server, which forces them to run the script with this line in your /etc/ssh/sshd_config:

Match User anonymous
ForceCommand 'python3 sshchan.py'

The script then provides the environment of a textboard so that users can make threads and posts from within the script.

Configuration

The role of the server admin is paramount. He decides the boards and all the configuration options (see more about configuration in docs/config.md) which control the behaviour of the script. Here are the configuration files:

  • /etc/sshchan.conf is the default one. sshchan reads this at startup, unless specified otherwise. To load a custom config, provide the path as first argument when running sshchan.py (e.g. python3 sshchan.py /path/to/config)
  • [root]/boardlist is the list of boards and their topic-titles, where [root] is the root directory of the chan.

The root directory of the chan can be set by the rootdir config option in /etc/sshchan.conf.

Roadmap

  • Decide upon and implement markup language for threads
  • ncurses GUI with Urwid this time, maybe?