Skip to content

Latest commit

 

History

History
73 lines (49 loc) · 2.1 KB

README.md

File metadata and controls

73 lines (49 loc) · 2.1 KB
Raw

koushoku

Source code of site [redacted] for those who are willing to run their own instance.

How it serve and index the archives

Archives and its files are served directly, without writing the files inside the archives into the disk (except for thumbnails). Archives inside the specified data directory will be indexed as long as it follows one of the following naming formats:

  • [Artist] Title (Magazine) [Foo] [Bar] [Crap] {tags kebab-case optional}
  • [Circle (Artist)] Title (Magazine) [Foo] [Bar] [Crap] {tags kebab-case optional}

Archives will be indexed concurrently, and usually takes several minutes (~1m10s for around ~8k archives). You can decrease the maximum concurrent numbers if your server is overloaded.

Prerequisites

  • Git
  • Go 1.18+
  • ImageMagick
  • Redis

Setup

Install the prerequisites

# Arch-based distributions
sudo pacman -Syu
sudo pacman -S git go imagemagick postgresql redis

# Debian-based distributions
sudo apt-get install -y software-properties-common
sudo add-apt-repository -y ppa:longsleep/golang-backports

sudo apt-get update -y
sudo apt-get install -y build-essential git golang-go postgresql imagemagick redis-server

Initialize database cluster

Only for Arch-based distributions - Before PostgreSQL can function correctly, the database cluster must be initialized - wiki.archlinux.org.

echo initdb -D /var/lib/postgres/data | sudo su - postgres

Enable and start PostgreSQL and Redis

# Arch-based distributions
systemctl --now enable postgresql redis

# Debian-based distributions
systemctl --now enable postgresql redis-server

Create a new database and user/role

sudo -u postgres psql --command "CREATE USER koushoku LOGIN SUPERUSER PASSWORD 'koushoku';"
sudo -u postgres psql --command "CREATE DATABASE koushoku OWNER koushoku;"

Build the back-end

git clone https://github.com/rs1703/koushoku
cd koushoku
make build

License

koushoku is licensed under the GNU General Public License v3.0.