|
5 years ago | |
---|---|---|
configs | 5 years ago | |
controllers | 5 years ago | |
db | 5 years ago | |
gulp/res | 5 years ago | |
helpers | 5 years ago | |
models | 5 years ago | |
schedules | 5 years ago | |
views | 5 years ago | |
.gitignore | 5 years ago | |
LICENSE | 6 years ago | |
README.md | 5 years ago | |
backup.sh.example | 5 years ago | |
ecosystem.config.js | 5 years ago | |
gulpfile.js | 5 years ago | |
package-lock.json | 5 years ago | |
package.json | 5 years ago | |
queue.js | 5 years ago | |
redis.js | 5 years ago | |
redlock.js | 5 years ago | |
server.js | 5 years ago | |
socketio.js | 5 years ago | |
worker.js | 5 years ago |
README.md
jschan
Anonymous imageboard. A type of BBS or forum software. Still in development, so beware if attempting to run a public instance. Demo site running at https://fatpeople.lol
Goals
- Oldschool imageboard look, with some modern touches
- Support users that have javascript disabled (TOR users, or the security conscious)
- Leverage nginx to serve static files, do GeoIP lookups and various other things
Features
- User created boards ala infinity
- Captcha and basic antispam
- Read-only JSON api
- Public modlogs
- Multi-select posts for moderation actions/reports
- Post styling & quote linking
- Backlinks shown without javascript
- Multiple files per post
- Websocket updates threads live
- Webring support lynxchan infinity
Todo
- Finish moderation tools (post editing, inter and
intra boardpost moving/thread merging, file hash bans,range bans, ban history) - Configuration editor on the site without touching config files
- Global settings page for filters, etc
- Overboard/multiboard/meta boards
- User created board custom pages
- File URL uploads
Setup
Please note these instructions are:
- Are not step-by-step or complete
- Assume you can read, are comfortable with a command line and have basic problem solving skills (aka google)
Requirements
- Linux (debian used in this example)
- Node.js (to run the app)
- MongoDB (database, duh)
- Redis (sessions, build task queue, locks, caching, websocket data)
- Nginx (handle https, serve static content, GeoIP lookup)
- Certbot/letsencrypt (for https cert)
- Graphicsmagick+Imagemagick (thumbnailing images, generating captchas)
- Ffmpeg (thumbnailing videos)
- Bcrypt (account password hashes)
Install some dependencies. You may need to add some sources.
$ sudo apt-get update
$ sudo apt-get install bcrypt nginx ffmpeg imagemagick graphicsmagick
Install and configure auth for mongodb. This is to avoid out of date verisons in debian repos.
Install and configure Redis.
Install nodejs. You can use node version manager (nvm) to help with this. Once you have nvm, install the LTS version of nodejs (currently 10.x).
$ nvm install --lts
Configure nginx. Modify the example config included in configs/nginx.example and put it in /etc/nginx/sites-available, then symlink it to /etc/nginx/sites-enabled. Make sure the sites enabled folder is included by the main nginx.conf Next, get https with a certificate generated from letsencrypt.
Now clone the repo, browse to the folder and set some things up.
# in repo directory
$ nano configs/main.json #edit config with appropriate data
$ npm run-script setup #install dependencies, pm2, gulp and run gulp tasks
$ npm run-script start #start all the backend processes
$ pm2 list #list running pm2 processes
$ pm2 logs #see logs