homebooru

KO | EN

gitlite — search

#javascript #python #react #typescript #llm #android #deep-learning #linux #java #vue #pytorch #security #mcp #openai

(★ 11)

Homebooru is a home solution for storing a large amount of images, created with the "booru-like" style in mind.

homebooru 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Homebooru
<div align="center">
    <img src="assets/cirno_smiling_touhou.png" width=500px \>
    <p><i><small>Artwork by <a href="https://twitter.com/nvi2762/status/1495867899881619456">Navi</a></small></i></p>
    <img src="https://img.shields.io/badge/-Python 3-3776AB?style=flat&logo=Python&logoColor=white" \>
    <img src="https://img.shields.io/badge/PostgreSQL-3776AB.svg?logo=postgreSQL&amp;logoColor=white" \>
    <img src="https://img.shields.io/badge/Docker-3776AB.svg?logo=docker&amp;logoColor=white" \><br>
    <img src="https://github.com/gingerchicken/homebooru/actions/workflows/test.yml/badge.svg" \>
    <p>A self-hosted <a href="https://www.yourdictionary.com/booru">Booru</a> written in <a href="https://www.djangoproject.com/">Python (Django)</a> for storing and sorting large media collections.</p>
</div>

## Installation
Included with the repository is a Docker compose configuration file, this should set everything up for you automatically. You can run the following command to start the server:

```bash
$ docker-compose up --build
```

## Configuration
By default, since the PostgreSQL database should be locked off from the rest of the network, the server will have a default username and password of `homebooru` and `H0meboOru!420`. You can change these by editing the `.env` file in the root directory.

> **Note:** If you wish to access the server from other computers on your network, you will need to change the [`validate.conf`](.nginx/sec/validate.conf) file in the `.nginx` directory. This is covered in the [Specifying origins](#specifying-origins) section.

### Specifying origins
Homebooru's nginx configuration is configured, by default, to only accept requests from `localhost` and `127.0.0.1`, this is to prevent unauthorised access from foreign hosts.

Don't worry, you can change this by editing the `validate.conf` file in the `.nginx` directory ([`.nginx/sec/validate.conf`](.nginx/sec/validate.conf)).

Firstly, let me explain briefly what an origin is; an origin is the address that you type into the address bar of your browser to access the server, so (_for me_) I would enter `https://10.0.2.43` and the origin would be `10.0.2.43`.  To allow this origin, I would add the following to the `validate.conf` file:

```conf
# Check that the origin is acceptable and expected.
if ($host !~* ^(localhost|127.0.0.1|10.0.2.43)$) {
    ...
```

Remember, if you are wishing to use a **domain name** (for example, `example.com`) you can add this here too:

```conf
if ($host !~* ^(localhost|127.0.0.1|10.0.2.43|example.com)$) {
    ...
```

> Of course, if you just want your domain to be the origin you could just remove the `localhost|127.0.0.1| ... ` etc. and just add `yourdomain.com` in its place.

## Contributions
If you have any suggestions for improvements, please open an issue on the [GitHub repository](https://github.com/gingerchicken/homebooru). If you have a bit of knowledge with Python and Django, feel free to fork the repository and submit a pull request for new features. Before contributing to the project, I would recommend reading some of the [Miscellaneous Project Information](/docs/MISC.md) to understand why certain things are implemented in certain ways and maybe what ethics you should work with when contributing (such as the low JavaScript dependence).

### Debug Environment
To make it easier to debug, I have created a `docker-compose.yml` file alongside a `.env` file, in the [`.debug`](.debug) directory.

This file is similar to the main `docker-compose.yml` file, but with the following differences:

- Persistent volumes are not used (i.e. no `volumes` section)
- The `nginx` container is not used.
- By default, **the container will only run unit tests** - (this is mainly to encourage contributors to write tests for their own code).
- Direct pass-through to the Django debug server is enabled. (by default, the port is set to `8000`)

That all sounds great, but how do I use this environment? This is very straight forward - just run the following command:

```bash
# Move to the .debug directory
$ cd .debug

# Run the debug environment
$ docker-compose up --build
```

And to stop the environment, run the following command (while in the .debug directory, of course):

```bash
$ docker-compose down
```

#### Enabling the Debug Web Server
As you may have read earlier, the debug environment is setup to run unit tests and close the server after the tests are complete, however sometimes you might want a more live/real-time server. To enable this, simply set `UNIT_TEST` to `False` in the [**debug** `.env`](.debug/.env) file like so:

```env
UNIT_TEST=False
```

homebooru

homebooru 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

homebooru

homebooru 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README