forked from e621ng/e621ng
061176e095
This makes the environment config understand booleans. If something ends with "?" it tries to interpret it as a boolean. A bunch of existing configs where changed to reflect this change.
67 lines
3.3 KiB
Markdown
67 lines
3.3 KiB
Markdown
## Installation (Easy mode - For development environments)
|
|
#### Prerequisites
|
|
* Latest version of Docker ([download](https://docs.docker.com/get-docker))
|
|
* Latest version of Docker Compose ([download](https://docs.docker.com/compose/install))
|
|
* Git ([download](https://git-scm.com/downloads))
|
|
|
|
If you are on Windows Docker Compose is already included, you do not need to install it yourself.
|
|
If you are on Linux/MacOS you can probably use your package manager.
|
|
|
|
#### Installation
|
|
1. Download and install the prerequisites.
|
|
2. Clone the repo with `git clone https://github.com/zwagoth/e621ng.git`.
|
|
3. `cd` into the repo.
|
|
4. Run the following commands:
|
|
```
|
|
docker-compose run -e DANBOORU_DISABLE_THROTTLES=true e621 /app/bin/setup
|
|
docker-compose up
|
|
```
|
|
After running the commands once only `docker-compose up` is needed to bring up the containers.
|
|
5. This would be a good time to rewatch your favorite TV series installment, cook & have breakfast/lunch/dinner, walk the dog, clean your room, etc.<br>
|
|
By the time you get back the install will surely have completed.<sup>1</sup>
|
|
6. To confirm the installation worked, open the web browser of your choice and enter `http://localhost:3000` into the address bar and see if the website loads correctly.
|
|
|
|
<sub><sup>1</sup> If the install did not finish by the time an activity is complete please select another activity to avoid crippling boredom.</sub>
|
|
|
|
#### Development Database
|
|
|
|
The postgres server accepts outside connections which you can use to connect with a local client. Use `localhost:34517` to connect to a database named `danbooru2` with the user `danbooru`. Leave the password blank, anything will work.
|
|
|
|
## Installation
|
|
|
|
Installation follows the same steps as the docker compose file. Ubuntu 20.04 is the current installation target.
|
|
There is no script that performs these steps for you, as you need to split them up to match your infrastructure.
|
|
Running a single machine install in production is possible, but is likely to be somewhat sluggish due to contention in disk between postgresql and elasticsearch.
|
|
Minimum RAM is 4GB. You will need to adjust values in config files to match how much RAM is available.
|
|
If you are targeting more than a hundred thousand posts and reasonable user volumes, you probably want to procure yourself a database server. See tuning guides for postgresql and elasticsearch for help planning these requirements.
|
|
|
|
## Troubleshooting
|
|
|
|
These instructions won't work for everyone. If your setup is not
|
|
working, here are the steps I usually recommend to people:
|
|
|
|
1) Test the database. Make sure you can connect to it using psql. Make
|
|
sure the tables exist. If this fails, you need to work on correctly
|
|
installing PostgreSQL, importing the initial schema, and running the
|
|
migrations.
|
|
|
|
2) Test the Rails database connection by using rails console. Run
|
|
Post.count to make sure Rails can connect to the database. If this
|
|
fails, you need to make sure your Danbooru configuration files are
|
|
correct.
|
|
|
|
3) Test Nginx to make sure it's working correctly. You may need to
|
|
debug your Nginx configuration file.
|
|
|
|
4) Check all log files.
|
|
|
|
### IQDB Service
|
|
|
|
IQDB integration is delegated to the [IQDBS service](https://github.com/zwagoth/iqdbs).
|
|
|
|
### Cropped Thumbnails
|
|
|
|
There's optional support for cropped thumbnails. This relies on installing
|
|
`libvips-8.6` or higher and setting `Danbooru.config.enable_image_cropping?`
|
|
to true.
|