https://github.com/nireo/booru
A imageboard built with golang
https://github.com/nireo/booru
authentication boards comments imageboard images posts
Last synced: 3 months ago
JSON representation
A imageboard built with golang
- Host: GitHub
- URL: https://github.com/nireo/booru
- Owner: nireo
- License: gpl-3.0
- Created: 2020-08-28T20:03:35.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-15T19:19:42.000Z (about 4 years ago)
- Last Synced: 2024-06-19T11:29:29.318Z (almost 2 years ago)
- Topics: authentication, boards, comments, imageboard, images, posts
- Language: Go
- Homepage:
- Size: 2.16 MB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# booru: A Classic Imageboard
## Setup
###### Docker
```bash
$ 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.
```bash
# 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.
```json
// 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.