bryanpedini
/
nyx
mirror of https://github.com/rls-moe/nyx
0
0
Fork 0
Code Releases Activity
3 Commits 1 Branch 0 Tags 1.8 MiB
Go 76.6%
HTML 19.7%
CSS 3.1%
Dockerfile 0.6%
Go to file
Tim Schuster 69b0d20825
MVP, no mod tools or anything but it works 		2017-03-12 20:37:53 +01:00
config MVP, no mod tools or anything but it works 2017-03-12 20:37:53 +01:00
http MVP, no mod tools or anything but it works 2017-03-12 20:37:53 +01:00
resources MVP, no mod tools or anything but it works 2017-03-12 20:37:53 +01:00
vendor MVP, no mod tools or anything but it works 2017-03-12 20:37:53 +01:00
.gitignore MVP, no mod tools or anything but it works 2017-03-12 20:37:53 +01:00
README.md Expanded Readme 2017-03-11 22:54:31 +01:00
main.go MVP, no mod tools or anything but it works 2017-03-12 20:37:53 +01:00

README.md

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.

Configuration

The configuration file is written in YAML.

The following is a list of options available;

  • disable_security - Disabled some HTTPS only options for cookies or redirects
  • 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