Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
jrosdahl committed Feb 28, 2021
1 parent 07ea062 commit 1d2717e
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ miniircd is a small and limited IRC server written in Python. Despite its size,
it is a functional alternative to a full-blown ircd for private or internal
use. Installation is simple; no configuration is required.


Features
--------

Expand All @@ -19,6 +20,7 @@ Features
without sending NACK can connect without long timeouts).
* Reasonably secure when used with --chroot and --setuid.


Limitations
-----------

Expand All @@ -30,20 +32,22 @@ Limitations
* No reverse DNS lookup.
* No other mechanism to reject clients than requiring a password.


Requirements
------------

Python 3.6 or newer. Get it at https://www.python.org.
Python 3.6 or newer. Get it at <https://www.python.org>.


Installation
------------

None. Just run "./miniircd --help" (or "python miniircd --help") to get some
None. Just run `./miniircd --help` (or `python3 miniircd --help`) to get some
help.

Using --chroot and --setuid
---------------------------

Using `--chroot` and `--setuid`
-------------------------------

In order to use the --chroot or --setuid options, you must be using an OS that
supports these functions (most \*nixes), and you must start the server as root.
Expand All @@ -53,12 +57,12 @@ instead of the user who launched miniircd.

To create a new chroot jail for miniircd, edit the Makefile and change JAILDIR
and JAILUSER to suit your needs, then run ``make jail`` as root. If you have a
motd file or an SSL pem file, you'll need to put them in the jail as well:
motd file or an SSL PEM file, you'll need to put them in the jail as well:

# cp miniircd.pem motd.txt /var/jail/miniircd

Remember to specify the paths for --state-dir, --log-dir, --motd and
--ssl-pem-file from within the jail, e.g.:
Remember to specify the paths for `--state-dir`, `--log-dir`, `--motd` and
`--ssl-pem-file` from within the jail, e.g.:

# miniircd --state-dir=/ --log-dir=/ --motd=/motd.txt --setuid=nobody \
--ssl-pem-file=/miniircd.pem --chroot=/var/jail/miniircd
Expand Down Expand Up @@ -87,16 +91,19 @@ should look something like this:
crw-rw-rw- 1 root root 1, 3 Jun 10 16:16 null
crw-rw-rw- 1 root root 1, 9 Jun 10 16:19 urandom


License
-------

GNU General Public License version 2 or later.


Primary author
--------------

- Joel Rosdahl <[email protected]>


Contributors
------------

Expand Down

0 comments on commit 1d2717e

Please sign in to comment.