mirror of
https://github.com/rls-moe/nyx
synced 2024-09-28 16:03:47 +02:00
84 lines
3.3 KiB
Markdown
84 lines
3.3 KiB
Markdown
# nyx - Imageboard
|
|
|
|
A simple, dependency-free image board.
|
|
|
|
## Requirements
|
|
|
|
* HTTPS Capable Host
|
|
* Being able to compile and run a go binary
|
|
* Disk Space
|
|
|
|
## Installation
|
|
|
|
Simply `go get` the source code or compile
|
|
it otherwise, dependencies are included.
|
|
|
|
## Usage
|
|
|
|
By default nyx works in volatile-mode,
|
|
all changes are only stored in memory and
|
|
default credentials are setup in the
|
|
database.
|
|
|
|
To overwrite these defaults, simply
|
|
create the file `config.yml` or specify
|
|
another file via the `-config` flag.
|
|
|
|
## Hostnames
|
|
|
|
Nyx seperates hostnames as distinct namespaces with their own content.
|
|
|
|
At the moment you cannot port content between namespaces.
|
|
|
|
## Administration
|
|
|
|
The administration panel is available under `/admin/` (don't forget the trailing slash), the default login is `admin` with password `admin`. It is recommended to add a new administrator and delete the default ID.
|
|
|
|
Here you can add boards, set board rules and start a database cleanup.
|
|
|
|
The cleanup will remove entries older than 7 days, deleted and orphaned threads and replies.
|
|
|
|
Once logged in as administrator you can also delete posts on the setup boards
|
|
or mark your own posts as special (though still anonymous)
|
|
|
|
## Posting
|
|
|
|
Posts are limited to 10k characters and uploads to 10MB including Base64 overhead (realistically you should be able to upload a 7MB file)
|
|
|
|
Nyx includes a system called "Trollthrottle". It will rate content based on how well it compresses, it's length and number of lines and the occurence of (currently fixed) keywords.
|
|
|
|
The end result is a spam score and a captcha probability, both displayed along
|
|
each post. The captcha probability specifies how like it is that a user
|
|
will fail a captcha despite having entered it correctly. This is capped at 99%, which means only 1 out of 100 correct solutions will be accepted.
|
|
|
|
This systems does not stop all trolls but will make it harder for people to post spam by forcing them to do more work.
|
|
|
|
## TripCodes
|
|
|
|
Tripcodes are non-traditional, they are calculated as the first 8 bytes of the
|
|
Blake2b Hashsum of the entered Code in Base64 Encoding.
|
|
|
|
Tripcodes do not offer a guarantee that a user is who they say they are as the
|
|
codes can be trivially cracked even on a mobile device.
|
|
|
|
## Configuration
|
|
|
|
The configuration file is written in YAML.
|
|
|
|
The following is a list of options available (and supported);
|
|
|
|
* `secret` - Secret used for User Login, CSRF and Session Management, default is `changeme`
|
|
* `listen_on` - Defaults to `:8080`, specifies on which port the HTTP server is launched. Nyx will not utilize this value otherwise so proxying is safe.
|
|
* `hosts` - A whitelists of hostnames that are allowed to be used. Nyx uses hostnames to differentiate several board collections.
|
|
* `db.file` - File to use for data storage, defaults to `:memory:` which means in-memory storage
|
|
* `site.title` - Site Title
|
|
* `site.description` - Site Description
|
|
* `captcha` - Captcha Mode, currently only `internal` is supported
|
|
|
|
The config accepts other options but these may not be supported.
|
|
|
|
## Infrequently Asked Questions
|
|
|
|
* **Where is the demo?**
|
|
|
|
* Hosting demos is hard. However, Nyx runs perfectly well on it's default settings, just launch the binary and open your browser on `localhost:8080`. Nyx won't persist any changes to disk unless you configure it to. I'll probably add a demo at some point tho (when I have working CI or something) |