booru

README

booru: A Classic Imageboard

Setup

Docker

$ docker-compose up

Note that this command use default installation configuration described in the docker_config.json. There are default admin credentials in there, so make sure to change it.

Standalone

The project is built with golang, but you can create a custom client in any language you want, since booru also works as a rest api. By default booru will serve html which leverages golang templates.

# Creating database (postgresql)
su - postgres
createdb dbname

Configuration file

Most of the fields are quite self explanatory. But the restApi field means that the server won't serve html templates, but instead JSON. This means you can build your own client, but use booru as the back-end.

// config.json
{
    "port": "8080",
    "adminAccess": true,
    "databaseHost": "localhost",
    "databasePort": "5432",
    "databaseUser": "postgres",
    "databasePass": "postgres",
    "databaseName": "dbname",
    "adminLogin": {
        "username": "admin",
        "password": "password"
    },
    "restApi": true
}

Running the code

go run main.go

Contributions

Feel free to create a pull request if you want to change anything, we can go from there.