szurubooru/README.md

# 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
scrubbing](http://sjp.pwn.pl/sjp/;2527372). It is pronounced as *shoorubooru*.

## Features

- Post content: images (JPG, PNG, GIF, animated GIF), videos (MP4, WEBM), Flash animations
- Post comments
- Post notes / annotations, including arbitrary polygons
- Rich JSON REST API ([see documentation](https://github.com/rr-/szurubooru/blob/master/API.md))
- Token based authentication for clients
- 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
- Duplicate detection
- Post rating and favoriting; comment rating
- Polished UI
- Browser configurable endless paging
- Browser configurable backdrop grid for transparent images

## Installation

It is recommended that you use Docker for deployment.
[See installation instructions.](https://github.com/rr-/szurubooru/blob/master/INSTALL.md)

Users who wish to avoid using Docker may find the [old installation instructions](https://github.com/rr-/szurubooru/blob/master/INSTALL-OLD.md) helpful.

## Screenshots

Post list:

![20160908_180032_fsk](https://cloud.githubusercontent.com/assets/1045476/18356730/3f1123d6-75ee-11e6-85dd-88a7615243a0.png)

Post view:

![20160908_180429_lmp](https://cloud.githubusercontent.com/assets/1045476/18356731/3f1566ee-75ee-11e6-9594-e86ca7347b0f.png)

## License

[GPLv3](https://github.com/rr-/szurubooru/blob/master/LICENSE.md).
docs/readme: add proper readme 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`
			`scrubbing](http://sjp.pwn.pl/sjp/;2527372). It is pronounced as shoorubooru.`

			`## Features`

			`- Post content: images (JPG, PNG, GIF, animated GIF), videos (MP4, WEBM), Flash animations`
			`- Post comments`
			`- Post notes / annotations, including arbitrary polygons`
			`- Rich JSON REST API ([see documentation](https://github.com/rr-/szurubooru/blob/master/API.md))`
server/auth: add token authentication * Users are only authenticated against their password on login, and to retrieve a token * Passwords are wiped from the GUI frontend and cookies after login and token retrieval * Tokens are revoked at the end of the session/logout * If the user chooses the "remember me" option, the token is stored in the cookie * Tokens correctly delete themselves on logout * Tokens can expire at user-specified date * Tokens have their last usage time * Tokens can have user defined descriptions * Users can manage login tokens in their account settings 2018-02-25 11:44:02 +01:00			`- Token based authentication for clients`
docs/readme: add proper readme 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`
			`- Duplicate detection`
			`- Post rating and favoriting; comment rating`
			`- Polished UI`
			`- Browser configurable endless paging`
			`- Browser configurable backdrop grid for transparent images`

docs: Moved confusing requirements to INSTALL-OLD.md 2019-04-21 18:40:39 +02:00			`## Installation`
docs/readme: add proper readme 2016-09-08 18:10:40 +02:00
build: add Docker functionality and documentation 2018-07-12 05:30:13 +02:00			`It is recommended that you use Docker for deployment.`
docs/readme: add proper readme 2016-09-08 18:10:40 +02:00			`[See installation instructions.](https://github.com/rr-/szurubooru/blob/master/INSTALL.md)`

docs: Moved confusing requirements to INSTALL-OLD.md 2019-04-21 18:40:39 +02:00			`Users who wish to avoid using Docker may find the [old installation instructions](https://github.com/rr-/szurubooru/blob/master/INSTALL-OLD.md) helpful.`

docs/readme: add proper readme 2016-09-08 18:10:40 +02:00			`## Screenshots`

			`Post list:`

			`![20160908_180032_fsk](https://cloud.githubusercontent.com/assets/1045476/18356730/3f1123d6-75ee-11e6-85dd-88a7615243a0.png)`

			`Post view:`

			`![20160908_180429_lmp](https://cloud.githubusercontent.com/assets/1045476/18356731/3f1566ee-75ee-11e6-9594-e86ca7347b0f.png)`

			`## License`

			`[GPLv3](https://github.com/rr-/szurubooru/blob/master/LICENSE.md).`