Skip to content

Latest commit

 

History

History
68 lines (48 loc) · 2.34 KB

README.md

File metadata and controls

68 lines (48 loc) · 2.34 KB

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 [email protected] 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.