Skip to content

Latest commit

 

History

History
108 lines (75 loc) · 1.75 KB

INSTALL.md

File metadata and controls

108 lines (75 loc) · 1.75 KB

Install

This document describes how to install Biblys on a local development environment. It is intended for developers who want to contribute to the project or test it locally, but not recommended for production use.

Requirements

  • Docker to use provided images:
    • Apache web server with PHP 8.1+
    • MySQL 8.0 / MariaDB
    • Mailpit
  • Composer

Local install for development

1. Clone git repository

git clone git@github.com:biblys/biblys.git

2. Install composer dependencies

cd biblys
composer install

3. Install starter theme

git clone git@github.com:biblys/biblys-theme-starter.git app
composer run theme:refresh

4. Copy the configuration file

cp config.example.yml config.yml

5. Add database credentials to config file

e.g. when using provided MySQL docker image:

db:
  host: biblys-mysql
  host_for_cli: 127.0.0.1
  port: 3306
  user: root
  pass:
  base: biblys

6. Add SMTP credentials to config file

Ability to send email is required for login.

eg. when using provided Mailpit docker image:

smtp:
  host: biblys-mailpit
  user: sender@example.com
  pass: password123
  port: 1025

7. Start docker containers

docker compose up -d

8. Create database

composer run propel:migrate

9. Add authentication secret

Generate a 32-chars long random string, e.g. with openssl:

openssl rand -hex 16

and add it to config.yml file:

authentication:
  secret: abcd1234…

10. Add seeds

composer run db:seed

11. Access site and login

Go to http://localhost:8088/

And login with admin account admin@paronymie.fr