Source code repository management made simple.
Packages is a PHP 5.6 and 7.x application providing an interface and tools for maintaining a private Composer repository. Packages extends Satis, adding a web frontend and useful management functionality like GitHub and GitLab integration.
Packages automatically registers GitLab and GitHub project webhooks to keep Satis up to date every time you push code. Packages also features a web management interface that allows for easy management of exposed packages and configured source control repositories.
Packages version 3 works on a plugin based system based around source code repositories. Packages can trigger, with each code push, many automated tasks like documentation generation or code analysis. The simple event-based architecture allows easy creation of new automation tasks.
- PHP 5.6 or later
- Some database platform supported by Doctrine 2 (sqlite works great!)
Download the latest release, or clone the repository.
git clone email@example.com:terramar-labs/packages.git
Switch to the project root directory and run
cd packages composer install
config.yml and edit as appropriate.
cp config.yml.dist config.yml vi config.yml
Generate the database schema
Packages uses Doctrine ORM to auto-generate the database schema for your configured platform.
Running the application
Start PHP's built-in webserver to run the Packages web application with minimal effort.
# Visit http://localhost:8080 to see the landing page. php -S localhost:8080 -t web
Start a Resque worker
For fully-automatic integration with GitHub, GitLab, and your Satis repository, you must always have at least one Resque worker running.
For more information on Resque workers, check the dedicated section.
Using the application
Read the usage and design documentation for an overview of Packages functionality.
index_dev.php in your browser to view the site with the
dev environment configuration. In this env, views and the service container are not cached, so changes made are immediately visible.
Check out the Contributing Guide for the recommended way to set up your development environment.
- Views are written using Twig and stored in
- Views are cached in
- All pages inherit from
views/base.html.twig, except for
- Public landing page views inherit from
- Views are cached in
- Composer Components are used to manage front-end dependencies. The respective
web/js/bootstrap.min.js, and such are symlinks pointing to the real files installed by Composer in
- Check the documentation for additional information.
Packages comes with an example
docker-compose.yml that starts an nginx container and a Redis container, ready to get up and running quickly.
Visit the documentation to get started.
index_dev.phpcontains a non-localhost block, comment it out when using Docker.
- Manage Resque and Satis using the
- Build the Satis
packages.jsonfile with the
- View queued Resque jobs in Redis with the
- View active Resque workers with the
- Start a Resque worker with
- Check the Resque logs to see if Resque is working properly.
tail -f logs/resque.log