This repository has been archived on 2024-10-25. You can view files and clone it, but cannot push or open issues or pull requests.
Sequenzia/README.md
2016-09-15 21:28:41 -04:00

48 lines
2.8 KiB
Markdown

![Logo](https://code.acr.moe/kazari/sequenzia/raw/master/public/images/logo.png "Logo")
# Sequenzia LTS (MyImouto LTS - ACR Rev.)
MyImouto is a clone of [Moebooru](https://github.com/moebooru/moebooru) for PHP and MySQL. In order for this clone to be as exact as possible, MyImouto uses a custom framework that is based on Ruby on Rails, thus the code from Moebooru was transcribed to PHP with some small modifications to fit the target language and framework.
MyImouto development stopped around 2014. By then, the port was mostly complete, with some bugs here and there. For more information about its features, changes and additions compared to Moebooru, please refer to the [About MyImouto](https://github.com/myimouto/myimouto/wiki/About-MyImouto) wiki.
This Project has now been taken in by ACR to support the LTS project [Sequenzia Project](https://acr.moe/index.php?title=Sequenzia_Project). Its completely open for remixing and branching. Some things are moddifed to fit our setup so
Very big thanks to Parziphal for his efforts in mantaing this project before we picked it up, his efforts are one of the reason this still works today!
## Requirements
* PHP 5.4 or higher.
* MySQL v5.5 or higher.
* PHP libraries:
* GD2
* PDO
* cURL
* Imagick (recommended)
* Memcached (recommended)
* Composer (Dependency Management for PHP).
* If running under Apache, the Rewrite mod must be enabled. Also, to serve gzipped CSS and JS files, the Headers mod is needed.
## Installation
For an explained, step-by-step guide, please check the following guides:
* [How to Install (Decentralized)](https://acr.moe/index.php/Build_a_Sequenzia_Booru) - Multiple Servers and with Off-Server Storage and Database
* [How to Install (Centralized)](https://code.acr.moe/kazari/myimouto/wikis/ubuntu-centralized-installation-guide) - All-In-One Setup
Otherwise, here's the quick guide for advanced users:
* Install system dependencies: `composer install`.
* Create a database for the booru.
* Create `config/config.php` and `config/database.yml` by copying their respective _.example_ files.
* Set your database configuration in `config/database.yml`.
* Configure the booru by editing `config/config.php`. For a minimum configuration, both `server_host` and `url_base` options must be correctly set.
* Run the installer: `php install.php`. Enter a name and password for the admin account when asked, then wait for the installation to finish.
* Finally, point the document root of your web server to the `public` folder. That's where the index.php file is.
## Updating
Every time you update the files, don't forget to run `composer update` to update dependencies, specially for the framework, and also run `php config/boot.php db:migrate` to run database migrations (if any).