orangeforum

command module
v1.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 15, 2017 License: BSD-3-Clause Imports: 12 Imported by: 0

README

Orange Forum

Orange Forum is an easy to deploy forum that has minimal dependencies and uses very little javascript. It is written is golang and a compiled binary is available for linux. Try the latest version hosted here. Please contact info@goodoldweb.com if you have any questions or want support.

How to use

By default, sqlite is used, so it's easy to get started. Download the binary and migrate the database with:

./orangeforum -migrate

Create a superadmin:

./orangeforum -createsuperuser

Finally, start the server:

./orangeforum

Notes

There are three types of privileged users in orangeforum: superadmin, admin, and mod. A superadmin has rights to everything across all groups. This includes editing/deleting/closing posts across all groups and editing the list of mods/admins for all groups in the forum. mods of a group can edit/delete/close posts in that group. admins of a group have all the privileges of mods for that group and can also edit the name/description of the group and assign mods for that group.

Orangeforum allows all users to create groups. The user that creates a group becomes an admin of that group. This can be disabled and group creation can be restricted to the superadmin.

Dependencies

  • Go 1.8 (only for compiling)
  • Postgres 9.5 (or use embedded sqlite3)

Options

  • -addr <port>: Use ./orangeforum -addr :8086 to listen on port 8086.
  • -dbdriver <db> and -dsn <data_source_name>: PostgreSQL and SQLite are supported. SQLite is the default driver.

To use postgres, run ./orangeforum -dbdriver postgres -dsn postgres://pguser:pgpasswd@localhost/orangeforum

To save an sqlite db at a different location, run ./orangeforum -dsn path/to/myforum.db.

Commands

  • -help: Show a list of all commands and options.
  • -migrate: Migrate the database. Run this once after updating the orangeforum binary (or when starting afresh).
  • -createsuperuser: Create a super admin.
  • -createuser: Create a new user with no special privileges.
  • -changepasswd: Change password of a user.
  • -deletesessions: Drop all sessions and log out all users.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
db

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL