2025-02-23 08:01:10 +00:00
|
|
|
# shioriko
|
2021-05-10 22:47:35 +07:00
|
|
|
|
2025-02-23 08:01:10 +00:00
|
|
|
a booru-style image gallery and organizer.
|
|
|
|
|
|
|
|
|
|
Built with the Go language and Svelte framework, shioriko is designed for personal image gathering.
|
|
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
* Upload and organize images
|
|
|
|
|
* Basic tagging system
|
|
|
|
|
* Search and autocomplete based on tags
|
|
|
|
|
* Similarity search and duplicate detection using perceptual hash
|
2021-05-10 22:47:35 +07:00
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
The easiest way to get started is to use Docker:
|
|
|
|
|
```bash
|
|
|
|
|
docker pull damillora/shioriko
|
2025-02-23 08:01:10 +00:00
|
|
|
docker run -e POSTGRES_DATABASE=<PostgreSQL DSN> -e AUTH_SECRET=<secret> -e DATA_DIR=/data -e BASE_URL=http://localhost:8080 -p 8080:8080 -v "./data:/data" damillora/shioriko
|
2021-05-10 22:47:35 +07:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Requirements
|
|
|
|
|
|
|
|
|
|
* PostgreSQL database
|
|
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
|
|
|
|
|
|
Shioriko is configured using environment variables:
|
|
|
|
|
|
|
|
|
|
* `POSTGRES_DATABASE`: DSN string of Postgres Database, see [Gorm documentation](https://gorm.io/docs/connecting_to_the_database.html)
|
|
|
|
|
* `AUTH_SECRET`: Secret used to sign JWTs
|
|
|
|
|
* `DATA_DIR`: Data directory to store images
|
|
|
|
|
* `BASE_URL`: Accesible URL of the instance
|
|
|
|
|
* `DISABLE_REGISTRATION`: Optional, disable registration on the instance
|
|
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
Shioriko is still in an early stage, but contributions are welcome!
|
|
|
|
|
|
|
|
|
|
## License
|
2025-02-23 08:01:10 +00:00
|
|
|
shioriko is licensed under the [MIT license](https://choosealicense.com/licenses/mit/).
|
