anonymous realtime imageboard focused on high performance, free speech and transparent moderation
bakape ea760d2dcd server: Automatic cookie domain detection 3 days ago
assets Migrate to Go 1.11 modules 4 months ago
auth server: Automatic cookie domain detection 3 days ago
cache cache: Fix race conditions in tests 2 months ago
client client: Assign domain for non-localhost cookies 3 weeks ago
clientScripts client: Remove stub C++ client 2 months ago
common server: Automatic cookie domain detection 3 days ago
config auth: Store captcha sessions as cookies 3 weeks ago
db docker: Run tests using docker-compose 6 days ago
docker/postgres docker: Run tests using docker-compose 6 days ago
docs deploying: docker-compose support 1 week ago
geoip server: Use system-wide geoip database 2 months ago
imager imager: Lock thumbnailing threads 1 week ago
lang Migrate to Go 1.11 modules 4 months ago
less less: Fix glass theme code operator visability 6 months ago
log log: Shorter error mail subject 2 months ago
parser cli: Remove inbuilt daemonization and config CLI 2 months ago
scripts docker: Run tests using docker-compose 6 days ago
server server: Automatic cookie domain detection 3 days ago
static auth: Store captcha sessions as cookies 3 weeks ago
templates client: Remove stub C++ client 2 months ago
test test: Fix import cycle 2 months ago
util Migrate to Go 1.11 modules 4 months ago
websockets auth: Store captcha sessions as cookies 3 weeks ago
www *: Replace illyadance with customizable video background 5 months ago
.clang-format wasm: Basic DOM mutation stack 1 year ago
.gitignore Migrate to Go 1.11 modules 4 months ago
.npmignore JS: Update package.json 10 months ago
.travis.yml make: rule for dockerised testing 5 months ago
COC.md *: Add COC 1 month ago
Dockerfile docker: Run tests using docker-compose 6 days ago
LICENSE LICENSE: Update copyright year 1 year ago
Makefile docker: Run tests using docker-compose 6 days ago
README.md docker: Run tests using docker-compose 6 days ago
docker-compose.yml docker: Run tests using docker-compose 6 days ago
go.mod server: Profiling endpoint 1 week ago
go.sum server: Profiling endpoint 1 week ago
gulpfile.js client: Revert service worker split 1 year ago
main.go Migrate to Go 1.11 modules 4 months ago
package-lock.json client: Remove stub C++ client 2 months ago
package.json npm: version: 1.1.3 -> 1.1.4 4 months ago

README.md

GoDoc Build Status

meguca

anonymous realtime imageboard focused on high performance, free speech and transparent moderation

Platforms: Linux, Docker

License: GNU AGPL

Runtime dependencies

Docker

Meguca can be deployed in a self-contained Docker container. Install Docker and Docker Compose and run

docker-compose build
docker-compose up -d

For more information refer to the Docker Compose docs.

Building from source

Native installation.

For installing meguca directly onto a server follow the steps bellow. A reference list of commands can be found in ./docs/installation.md

Build dependencies

  • Go >=1.11 (for building server)
  • Node.js >=5.0 (for building client)
  • C11 compiler
  • make
  • pkg-config
  • pthread
  • ffmpeg >= 3.1 libraries (libavcodec, libavutil, libavformat, libswscale) compiled with:
    • libvpx
    • libvorbis
    • libopus
    • libtheora
    • libx264
    • libmp3lame
  • OpenCV >= 2
  • libgeoip
  • git

Linux and OSX

  • Run make

Setup

Deployment

meguca can be started in debug mode simply with ./meguca. Configurations are split between meguca instance configurations and server instance configurations, which are required to start the server and connect to the database. The meguca instance configurations are stored in the database, but server instance configurations are optionally loaded from a config.json file on server start. A sample configuration file can be found under docs/config.json. Documentation for this file is available under docs/config.jsonc.

It is recommended to serve meguca behind a reverse proxy like NGINX or Apache with properly configured TLS settings. A sample NGINX configuration file can be found in docs/.

Initial instance configuration

  • Login into the “admin” account via the infinity symbol in the top banner with the password “password”
  • Change the default password
  • Create a board from the administration panel
  • Configure server from the administration panel

Development

  • See ./docs for more documentation
  • make server and make client build the server and client separately
  • make watch watches the file system for changes and incrementally rebuilds the client
  • make clean removes files from the previous compilation
  • make {test,test_no_race,test_docker} run regular, without data race detection and Dockerized test suites, respectively
  • To run server unit tests (unless Dockerized) add database creation rights to your PostgreSQL role