survos/album-bundle

Webelop Album is a photo management and publishing Symfony bundle

dev-master 2024-06-04 10:49 UTC

Requires

• php: ^8.1
• doctrine/common: ^2.8|^3.0
• doctrine/doctrine-bundle: ^1.8|^2.0
• doctrine/orm: ^2.6.3
• symfony/asset: ^6.4|^7.0
• symfony/routing: ^6.4|^7.0
• symfony/security-bundle: ^6.4|^7.0
• symfony/twig-bundle: ^6.4|^7.0

Requires (Dev)

• doctrine/doctrine-fixtures-bundle: ^3.3
• phpunit/phpunit: ^11.1
• rector/rector: ^1.1
• symfony/browser-kit: ^6.4|^7.0
• symfony/css-selector: ^6.4|^7.0
• symfony/framework-bundle: ^6.4|^7.0
• symfony/phpunit-bridge: ^6.4|^7.0
• symfony/validator: ^6.4|^7.0
• symfony/yaml: ^6.4|^7.0

MIT

• Jean-Charles Callu
• Tac Tacelosky

README

This is a complete Symfony bundle for running a light-weight photo browsing and sharing website on a PHP server.

The server may resize and prepare the previews and video streams or rely on existing previews generated on the end-user's computer. As the bundle is designed to work on low-powered devices, it is advised to install the additional helpers on the local computers to synchronise and prepare the image previews.

Packagist: Survos/SurvosAlbumBundle

Forked from abandoned package: Webelop/AlbumBundle

Requirements

This bundle depends on Doctrine bundle, Symfony security, routing and Twig. Symfony 6.4+

Installation

• Install the composer package:

composer require survos/album-bundle

• Adjust the configuration in config/packages/webelop_album.yml or .env

  # Path to the pictures directory on the server
  WEBELOP_ALBUM_ROOT="/path/to/pictures"
  # Salt used to generate secure photos urls
  WEBELOP_SALT="A Not So Secret Salt. Change it!"
  

• Adjust the bundle url prefix in config/routes/webelop_album.yaml. Eg

  _webelop_album:
    resource: '@WebelopAlbumBundle/Resources/config/routes.xml'
    prefix: /album
  

• Set-up security for the bundle in config/packages/security.yaml. Eg:

      access_control:
        - { path: ^/album/manager, roles: ROLE_ADMIN }
        - { path: ^/album, roles: IS_AUTHENTICATED_ANONYMOUSLY }
  

• Access the site at eg: http://localhost/album/manager

Additional helpers:

bin/photosync

A shell utility which uses unison and helper modules to resize pictures, purge dropbox uploads or prepare video previews on the host computer.

When photosync is setup, computers in the household become master photo devices. Running photosync will synchronise a preset folder from any computer to the server and optionally prepare preview files. This allows the server to be directly ready to serve the new images after successful sync.

docker-compose template

docker/docker-compose.yml refers to a nginx, php-fpm, mysql install which can be used to test the bundle.

# Start docker-compose as a daemon
bin/dcompose up -d

# Install composer dependencies
bin/dcomposer install

# Run bundle tests
bin/dcompose exec php vendor/bin/simple-phpunit

Useful resources:

• eko/docker-symfony: a complete docker-composer image for running a symfony project
• unison: a two-way, ssh based sync utility. It must be installed and on the same version on both client and server.

Contributing

Thanks for considering contributing to this project. You are very welcome to propose a PR! You should first check locally that bin/all-tests runs properly and ensure that any changes leave the codebase as clean and secure as possible