dereban / meguca Goto Github PK

Real-time imageboard. MIT licensed.

NOTE: The git master branch contains the development version of the board. Crashes are not uncommon as new features are added and patched. For more stable revisions, please download the latest release.

##Setup

• Install dependencies listed below
• Sign up for reCAPTCHA
• Run npm install to install npm deps and compile C++ addons
• Configure the files in config/
• Run node builder.js to run an auto-reloading development server

##Automatic cross-platform development setup:

• Install git, VirtualBox and Vagrant
• Open a shell in meguca's root directory and run vagrant up
• Grab a coffee
• Run vagrant ssh and node builder, once logged in. Your changes will automatically sync both ways. More info

##Production

• Have your webserver serve www/
  • Some features will not work without a dedicated webserver. It is highly recommended not to use the the default inbuilt webserver in production.
• Run node server/server.js for just the server
• You can update config/hot.js on-the-fly with node server/kill.js
• To remove compiled server dependancies run make clean
• Similarly make client_clean removes compiled client files

##Updating

• To recompile client code & CSS run make client. The new files can be loaded into a running server with node server/kill.js
• After upgrading a node.js/io.js version or a meguca release run make upgrade to recompile all dependancies

##Dependencies

• ImageMagick
• gcc, g++, make
• libpng with development headers
• io.js >=2.0.0
• redis

###Optional dependencies for various features

• ffmpeg 2.2+ for WebM support
  • with libmp3lame for MP3
• pngquant 2.3.0+ for PNG thumbnails

###Optional npm dependancies

• node-expat for icecast now-playing banners

• JSON API documentation: docs/api.md
• init script example: docs/doushio.initscript.example
• ngingx configuration example: docs/nginx.config.example

##Standalone upkeep scripts

• scripts/backup.js - uploads rdb to S3
• scripts/backup.sh - MEGA backup script
• scripts/purge_bans.sh - Removes all bans
• scripts/purge_mod_sessions.sh - Closes all active moderator sessions
• scripts/radio.js - icecast2 server integration