- [x] Webring w/proxy support (compatible with [lynxchan](https://gitlab.com/alogware/LynxChanAddon-Webring) & [infinity](https://gitlab.com/Tenicu/infinityaddon-webring))
- [x] Run as a tor hidden service
- [x] Webring w/proxy support (compatible with [lynxchan](https://gitlab.com/alogware/LynxChanAddon-Webring) & [infinity](https://gitlab.com/Tenicu/infinityaddon-webring) versions)
- [x] Manage everything from the web panel
- [x] Works properly with anonymizer networks
## Todo
- More features
- Mobile app integration
- Improve installation instructions
## Wants
- docker-compose file, use docker volumes and networks for super easy installation, backup and migration
- Mobile app integration (somebody pls)
## Setup
##### Please note:
#### 🚨 jschan is not production-ready. There may be bugs and WILL be breaking changes. 🚨
##### If you insist on running your own instance, do not expect help when something breaks. Please read everything including the update section thoroughly. These instructions are NOT step-by-step or complete, and assume you have some experience with software setup, servers, networking, etc.
##### These instructions are not for the uninitiated and assume you have a brain. Follow them carefully and you will have a nice working imageboard by the end.
- Basic security like ssh root login disabled, key login only, firewall all ports besides http/s and ssh.
- Basic security like ssh root login disabled, key login only, firewall (ufw works) deny all incoming on ports besides http/s and ssh.
**2. Install dependencies.**
NOTE: You may need to add sources depending on your distro. If you intent to have animated gif thumbnails, ffmpeg 4.3.x is recommended. For debian, it can be found in the testing repos or compiled from source.
NOTE: You may need to add sources depending on your distro. If you want animated gif thumbnails, ffmpeg ?=4.3.x is recommended. For debian, it can be found in the testing repos or compiled from source.
For easy installation, use [node version manager](https://github.com/nvm-sh/nvm) "nvm".
For easy installation, use [node version manager](https://github.com/nvm-sh/nvm) "nvm".
Install nvm then run the following commands to get the LTS version of nodejs.
```bash
$ nvm install --lts
@ -99,6 +99,7 @@ $ sudo sed -i 's/domain.com/your.domain.com/g' /etc/nginx/sites-available/DOMAIN
- Make sure the sites enabled folder is included by `/etc/nginx/nginx.conf` (it is in debian nginx package)
- Use [certbot](https://certbot.eff.org/) to get a free https certificate.
- For post flags to work, [follow this guide](http://archive.is/2SMOb) to setup the [legacy GeoIP database](https://www.miyuru.lk/geoiplegacy) and add these directives to the http block in `/etc/nginx/nginx.conf`:
```
geoip_country /usr/share/GeoIP/GeoIP.dat;
@ -110,10 +111,12 @@ If you use cloudflare, please read [these](https://support.cloudflare.com/hc/en-
Also included is an "nginx_advanced" config, and a snippets folder for advanced users who want to better organise and more easily customise the nginx configuration. It functions the same as the normal nginx.example, but you need to create the snippets folder in /etc/nginx/snippets, and copy the example snippets.
- Use https://realfavicongenerator.net/ to generate favicons how you want them to look and replace the files in gulp/res/icons/ with the icons from that package.
**7. Clone this repo, browse to the folder and set some things up**
```bash
# copy example secrets file and edit it
# copy example secrets file and edit it to fill out the details
# copy example custompages for rules and faq and edit
@ -125,18 +128,14 @@ $ npm install
$ npm run-script setup
# setup the database and folder structure, and creates the admin account. **The (random) password will be printed in the command line.**
$ gulp reset
$ gulp reset
# NOTE: dont run gulp reset again unless you want to completely irreversibly wipe everything
# make pm2 (process manager) start on server restart
$ pm2 startup #and follow any prompts
# save the process list so jschan is started with pm2
$ pm2 save
```
Use https://realfavicongenerator.net/ to generate favicons how you want them to look and replace the files in gulp/res/icons/ with the icons from that package
```bash
# start all the backend processes
$ npm run-script start
$ gulp
@ -148,6 +147,7 @@ $ pm2 logs #see logs
$ pm2 reload all #reload all backend processes
# gulp is used for various jobs like minifying and compiling scripts
# the build-worker process may also run some of these for certain operations e.g. editing global settings in the web panel
$ gulp --tasks #list available gulp tasks
$ gulp migrate #check for and run db migrations
$ gulp password #reset the admin account password if you forgot it
- Install docker and run torproxy in a container: https://github.com/dperson/torproxy (of course, audit the docker image yourself). This is the easiest, free way to get a proxy setup and means you can also follow .onions in your webring list since requests will go through tor.
- Use the socks proxy already provided by the tor daemon
- Install docker and run torproxy in a container: https://github.com/dperson/torproxy (of course, audit the docker image yourself).
- Use the socks proxy provided by a non-docker tor daemon, which is probably already setup on port 9050 if you have a tor installed for hidden service.
- Use your own socks proxy
Edit configs/webring.json with your proxy address and set enabled: true
Then update the proxy address in global settings. The first 2 will allow you to follow .onions in your webring follow list.
## Updating
@ -171,13 +171,15 @@ Edit configs/webring.json with your proxy address and set enabled: true
$ git pull
#install dependencies again in case any have updated or changed
$ npm install
#run the migrate task to update your database
#run the gulp migrate task. this will update things such as your database schema
$ gulp migrate
#reload jschan backend
$ pm2 reload all
#run the default gulp task, updates scripts, css, icons, images and deletes old html
#stop the jschan backend
$ pm2 stop all
#run the default gulp task to update, scripts, css, icons, images and delete old html
$ gulp
#if something breaks, check and read the logs, they will help figure out what went wrong.
#start the backend again
$ pm2 restart all
#if something breaks, check and read the logs, they will help figure out what went wrong
