2016-09-08 18:10:40 +02:00
|
|
|
# szurubooru
|
|
|
|
|
|
|
|
|
|
Szurubooru is an image board engine inspired by services such as Danbooru,
|
|
|
|
|
Gelbooru and Moebooru dedicated for small and medium communities. Its name [has
|
|
|
|
|
its roots in Polish language and has onomatopeic meaning of scraping or
|
2022-03-21 14:24:40 +01:00
|
|
|
scrubbing](https://sjp.pwn.pl/sjp/;2527372). It is pronounced as *shoorubooru*.
|
2016-09-08 18:10:40 +02:00
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
|
|
|
|
|
- Post content: images (JPG, PNG, GIF, animated GIF), videos (MP4, WEBM), Flash animations
|
2023-08-17 14:58:09 +02:00
|
|
|
- Ability to retrieve web video content using [yt-dlp](https://github.com/yt-dlp/yt-dlp)
|
2016-09-08 18:10:40 +02:00
|
|
|
- Post comments
|
|
|
|
|
- Post notes / annotations, including arbitrary polygons
|
2019-08-06 01:15:37 +02:00
|
|
|
- Rich JSON REST API ([see documentation](doc/API.md))
|
2018-02-25 11:44:02 +01:00
|
|
|
- Token based authentication for clients
|
2016-09-08 18:10:40 +02:00
|
|
|
- Rich search system
|
|
|
|
|
- Rich privilege system
|
|
|
|
|
- Autocomplete in search and while editing tags
|
|
|
|
|
- Tag categories
|
|
|
|
|
- Tag suggestions
|
|
|
|
|
- Tag implications (adding a tag automatically adds another)
|
|
|
|
|
- Tag aliases
|
2020-05-05 04:12:54 +02:00
|
|
|
- Pools and pool categories
|
2016-09-08 18:10:40 +02:00
|
|
|
- Duplicate detection
|
|
|
|
|
- Post rating and favoriting; comment rating
|
|
|
|
|
- Polished UI
|
|
|
|
|
- Browser configurable endless paging
|
|
|
|
|
- Browser configurable backdrop grid for transparent images
|
|
|
|
|
|
2019-04-21 18:40:39 +02:00
|
|
|
## Installation
|
2016-09-08 18:10:40 +02:00
|
|
|
|
2018-07-12 05:30:13 +02:00
|
|
|
It is recommended that you use Docker for deployment.
|
2019-08-06 01:15:37 +02:00
|
|
|
[See installation instructions.](doc/INSTALL.md)
|
2016-09-08 18:10:40 +02:00
|
|
|
|
2020-06-05 16:29:52 +02:00
|
|
|
More installation resources, as well as related projects can be found on the
|
|
|
|
|
[GitHub project Wiki](https://github.com/rr-/szurubooru/wiki)
|
2019-04-21 18:40:39 +02:00
|
|
|
|
2016-09-08 18:10:40 +02:00
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
Post list:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Post view:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
2019-08-06 01:15:37 +02:00
|
|
|
[GPLv3](LICENSE.md).
|
