jschan/README.md

# jschan

Anonymous imageboard software.

Demo/test instance: [Clearnet](https://fatchan.org), [Tor hidden service](http://cimixezweeq64g42vl6tyhk4becxhi4ldwqq6w43u53qhwsd3s4c3lyd.onion/), [Lokinet SNApp](http://fatchan.loki/)

API documentation: [fatchan/jschan-docs](https://gitgud.io/fatchan/jschan-docs/) - Gitgud pages link: http://fatchan.gitgud.site/jschan-docs/#introduction

Join the IRC: [open in client](ircs://irc.fatpeople.lol:6697/general) OR: [webchat](https://irc.fatpeople.lol/#general)

## Features
- [x] User created boards ala [infinity](https://github.com/ctrlcctrlv/infinity)
- [x] Multiple files per post
- [x] Antispam/Anti-flood & DNSBL
- [x] 3 customisable inbuilt captchas + 2 third party captchas (hcaptcha & recaptcha)
- [x] [API documentation](http://fatchan.gitgud.site/jschan-docs/)
- [x] Built-in webring (compatible w/ [lynxchan](https://gitlab.com/alogware/LynxChanAddon-Webring) & [infinity](https://gitlab.com/Tenicu/infinityaddon-webring))
- [x] [Tegaki](https://github.com/desuwa/tegaki) applet with drawing and replays
- [x] Manage everything from the web panel
- [x] Detailed accounts permissions system
- [x] Works properly with anonymizer networks (Tor, Lokinet, etc)
- [x] Beautiful bundled frontend with lots of themes and options, see below:

![screenshots](collage.gif "screenshots")

## License
GNU AGPLv3, see [LICENSE](LICENSE).

## Installation & Upgrading
See [INSTALLATION.md](INSTALLATION.md) for instructions on setting up a jschan instance or upgrading to a newer version.

## Changelog
See [CHANGELOG.md](CHANGELOG.md) for changes between versions.

## Contributing
Interested in contributing to jschan development? See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.

## Related Projects
Here are some other projects related to jschan that you might find useful. **These are not official or otherwise guaranteed to work or be safe and should be used at your own risk.**
 - [myumyu/globalafk](https://gitgud.io/myumyu/globalafk/) - "A simple python script that sends ugly notifications when something happens on a jschan imageboard that you moderate."
 - [ussaohelcim/jschan-api-sdk](https://github.com/ussaohelcim/jschan-api-sdk) - JavaScript/TypeScript SDK for jschan.
 - [ussaohelcim/jschan-api-types](https://github.com/ussaohelcim/jschan-api-types) - TypeScript typings for jschan API.

## For generous people

Bitcoin (BTC): [`bc1q4elrlz5puak4m9xy3hfvmpempnpqpu95v8s9m6`](bitcoin:bc1q4elrlz5puak4m9xy3hfvmpempnpqpu95v8s9m6)

Monero (XMR): [`89J9DXPLUBr5HjNDNZTEo4WYMFTouSsGjUjBnUCCUxJGUirthnii4naZ8JafdnmhPe4NP1nkWsgcK82Uga7X515nNR1isuh`](monero:89J9DXPLUBr5HjNDNZTEo4WYMFTouSsGjUjBnUCCUxJGUirthnii4naZ8JafdnmhPe4NP1nkWsgcK82Uga7X515nNR1isuh)

Oxen (OXEN): `LBjExqjDKCFT6Tj198CfK8auAzBERJX1ogtcsjuKZ6AYWTFxwEADLgf2zZ8NHvWCa1UW7vrtY8DJmPYFpj3MEE69CryCvN6`
First commit 5 years ago			`# jschan`
README polish 2 years ago
Update README.md 4 years ago			`Anonymous imageboard software.`
Update README.md 4 years ago
new loki address 3 years ago			`Demo/test instance: [Clearnet](https://fatchan.org), [Tor hidden service](http://cimixezweeq64g42vl6tyhk4becxhi4ldwqq6w43u53qhwsd3s4c3lyd.onion/), [Lokinet SNApp](http://fatchan.loki/)`
update demo/test site links, and put my btc address at the bottom thanks to anon donor 4 years ago
add docs repo and gitgud pages link to README 3 years ago			`API documentation: [fatchan/jschan-docs](https://gitgud.io/fatchan/jschan-docs/) - Gitgud pages link: http://fatchan.gitgud.site/jschan-docs/#introduction`

README polish 2 years ago			`Join the IRC: [open in client](ircs://irc.fatpeople.lol:6697/general) OR: [webchat](https://irc.fatpeople.lol/#general)`
Section README, link to other docs (contributing, license, installation, etc) and clean and improve them a little 3 years ago
Update README.md 5 years ago			`## Features`
README polish 2 years ago			`- [x] User created boards ala [infinity](https://github.com/ctrlcctrlv/infinity)`
update README and config.example with more comments and relevant info 5 years ago			`- [x] Multiple files per post`
README polish 2 years ago			`- [x] Antispam/Anti-flood & DNSBL`
			`- [x] 3 customisable inbuilt captchas + 2 third party captchas (hcaptcha & recaptcha)`
minor readme tweaks 2 years ago			`- [x] [API documentation](http://fatchan.gitgud.site/jschan-docs/)`
			`- [x] Built-in webring (compatible w/ [lynxchan](https://gitlab.com/alogware/LynxChanAddon-Webring) & [infinity](https://gitlab.com/Tenicu/infinityaddon-webring))`
README polish 2 years ago			`- [x] [Tegaki](https://github.com/desuwa/tegaki) applet with drawing and replays`
Improve README 3 years ago			`- [x] Manage everything from the web panel`
typo 2 years ago			`- [x] Detailed accounts permissions system`
README polish 2 years ago			`- [x] Works properly with anonymizer networks (Tor, Lokinet, etc)`
			`- [x] Beautiful bundled frontend with lots of themes and options, see below:`
Update README.md 5 years ago
update README.md, move image position below features 2 years ago			`![screenshots](collage.gif "screenshots")`

Section README, link to other docs (contributing, license, installation, etc) and clean and improve them a little 3 years ago			`## License`
			`GNU AGPLv3, see [LICENSE](LICENSE).`
README update & improvements, and add note to 0.1.3 migration about generate-favicon gulp task 3 years ago
Section README, link to other docs (contributing, license, installation, etc) and clean and improve them a little 3 years ago			`## Installation & Upgrading`
			`See [INSTALLATION.md](INSTALLATION.md) for instructions on setting up a jschan instance or upgrading to a newer version.`
Update readme with notes about tor, new captcha options and basic updating instructions 4 years ago
Section README, link to other docs (contributing, license, installation, etc) and clean and improve them a little 3 years ago			`## Changelog`
			`See [CHANGELOG.md](CHANGELOG.md) for changes between versions.`
README improvement, nginx configs moved, nginx error pages fixed 4 years ago
Section README, link to other docs (contributing, license, installation, etc) and clean and improve them a little 3 years ago			`## Contributing`
			`Interested in contributing to jschan development? See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.`
update demo/test site links, and put my btc address at the bottom thanks to anon donor 4 years ago
add related projects section with globalafk to readme 3 years ago			`## Related Projects`
README polish 2 years ago			`Here are some other projects related to jschan that you might find useful. These are not official or otherwise guaranteed to work or be safe and should be used at your own risk.`
add related projects section with globalafk to readme 3 years ago			`- [myumyu/globalafk](https://gitgud.io/myumyu/globalafk/) - "A simple python script that sends ugly notifications when something happens on a jschan imageboard that you moderate."`
add links to related projects, typescript SDK and typings from ussaohelcim <3 2 years ago			`- [ussaohelcim/jschan-api-sdk](https://github.com/ussaohelcim/jschan-api-sdk) - JavaScript/TypeScript SDK for jschan.`
README correction 2 years ago			`- [ussaohelcim/jschan-api-types](https://github.com/ussaohelcim/jschan-api-types) - TypeScript typings for jschan API.`
add related projects section with globalafk to readme 3 years ago
update demo/test site links, and put my btc address at the bottom thanks to anon donor 4 years ago			`## For generous people`

README update & improvements, and add note to 0.1.3 migration about generate-favicon gulp task 3 years ago			Bitcoin (BTC): [`bc1q4elrlz5puak4m9xy3hfvmpempnpqpu95v8s9m6`](bitcoin:bc1q4elrlz5puak4m9xy3hfvmpempnpqpu95v8s9m6)

			Monero (XMR): [`89J9DXPLUBr5HjNDNZTEo4WYMFTouSsGjUjBnUCCUxJGUirthnii4naZ8JafdnmhPe4NP1nkWsgcK82Uga7X515nNR1isuh`](monero:89J9DXPLUBr5HjNDNZTEo4WYMFTouSsGjUjBnUCCUxJGUirthnii4naZ8JafdnmhPe4NP1nkWsgcK82Uga7X515nNR1isuh)
add my OXEN address 3 years ago
			Oxen (OXEN): `LBjExqjDKCFT6Tj198CfK8auAzBERJX1ogtcsjuKZ6AYWTFxwEADLgf2zZ8NHvWCa1UW7vrtY8DJmPYFpj3MEE69CryCvN6`