Install

Requirements

• Stable PHP (8.2+ as of writing)
• A database, any of:
  • SQLite 3.37+ (simplest - recommended for small or medium installs with tens of users and thousands of posts)
  • PostgreSQL 14+ (most scalable - recommended for large sites with thousands of users and millions of posts)
  • MySQL 8.0+ (if that's all your web host offers)
• An image thumbnailing tool, any of:
  • ImageMagick (recommended)
  • GD (if that's all your web host offers)

Get the Code

Two main options:

1. Via Git (allows easiest updates via git pull):
   1. git clone https://github.com/shish/shimmie2
   2. Install Composer.
      1. brew install composer on macOS
   3. Run composer install in the shimmie folder.
2. Via Stable Release: Download the latest release under Releases.

Install

1. Create an empty database (skip if using SQLite)
2. Start a PHP server at the project root directory: php -S localhost:9000 tests/router.php
3. Open http://localhost:9000/ in a web browser
4. If prompted, enter the location of the database
5. Click "Install". Hopefully you'll end up at the welcome screen; if not, you should be given instructions on how to fix any errors~

Webserver Integrations

For integration with nginx, lighttpd, varnish, etc - see the https://github.com/shish/shimmie2-examples repository