eBooru/README.md

91 lines
2.7 KiB
Markdown
Raw Normal View History

2015-05-21 15:15:34 -04:00
### Installation
2010-02-04 15:08:49 -05:00
2011-09-30 15:50:08 -04:00
It is recommended that you install Danbooru on a Debian-based system
2015-05-21 15:15:34 -04:00
since most of the required packages are available on APT. Danbooru
2011-10-05 17:53:43 -04:00
has been successfully installed on Fedora, CentOS, FreeBSD, and OS X.
The INSTALL.debian install script is straightforward and should be
2015-05-21 15:15:34 -04:00
simple to adapt for other platforms.
2010-02-11 14:59:58 -05:00
2011-09-30 15:50:08 -04:00
For best performance, you will need at least 256MB of RAM for
PostgreSQL and Rails. The memory requirement will grow as your
2015-05-21 15:15:34 -04:00
database gets bigger.
On production Danbooru uses PostgreSQL 9.4, but any 9.x release should
work.
2010-02-11 14:59:58 -05:00
2011-09-30 15:50:08 -04:00
Use your operating system's package management system whenever
possible. This will simplify the process of installing init scripts,
which will not always happen when compiling from source.
2010-02-04 15:08:49 -05:00
2015-05-21 15:15:34 -04:00
### Troubleshooting
2010-02-04 15:08:49 -05:00
2011-09-30 15:50:08 -04:00
These instructions won't work for everyone. If your setup is not
working, here are the steps I usually recommend to people:
2010-02-04 15:08:49 -05:00
2011-09-30 15:50:08 -04:00
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.
2010-02-04 15:08:49 -05:00
2010-02-11 14:59:58 -05:00
2) Test the Rails database connection by using rails console. Run
2011-09-30 15:50:08 -04:00
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.
2010-02-04 15:08:49 -05:00
2011-09-30 15:50:08 -04:00
3) Test Nginx to make sure it's working correctly. You may need to
debug your Nginx configuration file.
2010-02-04 15:08:49 -05:00
2011-09-30 15:50:08 -04:00
4) Check all log files.
2014-03-24 17:38:06 -04:00
2017-04-04 20:10:00 -04:00
### Amazon Web Services
In order to enable the following features, you will need an AWS SQS
account:
* Pool versions
* Post versions
* IQDB
* Saved searches
* Related tags
### Google APIs
The following features requires a Google API account:
* Bulk revert
* Post versions report
2015-05-21 15:15:34 -04:00
### IQDB Integration
2014-03-24 17:38:06 -04:00
2016-12-02 16:21:56 -05:00
IQDB integration is now delegated to the [IQDBS service](https://github.com/r888888888/iqdbs).
2014-03-24 17:38:06 -04:00
2016-12-02 16:21:56 -05:00
You will need to install your own copy and enable the appropriate
2016-12-14 21:09:45 -05:00
configuration settings.
### Listbooru Service
In order to access saved search functionality you will need to install and
configure the [Listbooru service](https://github.com/r888888888/listbooru).
2016-12-14 21:09:45 -05:00
### Archive Service
2017-09-25 17:51:04 -04:00
In order to access versioned data for pools and posts you will
need to install and configure the [Archives service](https://github.com/r888888888/archives).
2017-04-04 20:10:00 -04:00
### Reportbooru Service
The following features are delegated to the [Reportbooru service](https://github.com/r888888888/reportbooru):
* Related tags
* Missed searches report
* Popular searches report
* Favorite searches
* Upload trend graphs
* Similar users (via favorites and post votes)
2018-07-20 13:36:16 -04:00
### 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.