PHPackages realshadow/satis-control-panel - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Admin Panels](/categories/admin) 4. / 5. realshadow/satis-control-panel ActiveProject[Admin Panels](/categories/admin) realshadow/satis-control-panel ============================== Satis Control Panel (SCP) is a simple web UI for managing your Satis Repository for Composer packages. 1.1.0(8y ago)1532.3k29[4 issues](https://github.com/realshadow/satis-control-panel/issues)[4 PRs](https://github.com/realshadow/satis-control-panel/pulls)MITPHPPHP >=5.5.9 Since Feb 9Pushed 7y ago7 watchersCompare [ Source](https://github.com/realshadow/satis-control-panel)[ Packagist](https://packagist.org/packages/realshadow/satis-control-panel)[ RSS](/packages/realshadow-satis-control-panel/feed)WikiDiscussions master Synced 4w ago READMEChangelog (10)Dependencies (9)Versions (11)Used By (0) [![Scrutinizer Code Quality](https://camo.githubusercontent.com/282ff76acab78cca5453b7bf8fd6d9e84b8d525a8bbda01649f7838beec02c94/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f7265616c736861646f772f73617469732d636f6e74726f6c2d70616e656c2f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/realshadow/satis-control-panel/?branch=master) [![Build Status](https://camo.githubusercontent.com/7e35d6328ed7496b1aeeb22eb404e8276cc562965905f9292fb6591421a6452b/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f7265616c736861646f772f73617469732d636f6e74726f6c2d70616e656c2f6261646765732f6275696c642e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/realshadow/satis-control-panel/build-status/master) Satis Control Panel =================== [](#satis-control-panel) Satis Control Panel (SCP) is a simple web UI for managing your [Satis Repository](https://github.com/composer/satis) for [Composer Packages](https://getcomposer.org/). SCP backend is written in Laravel and with a React + Typescript combo. Features -------- [](#features) - simple UI for managing your Satis configuration file for both - private packages and public packages mirrored from [Packagist](https://packagist.org/) - no database required - only PHP and optional Nodejs server for automatic generation of Satis configuration file - RESTful API for integration with CI services - SCP comes with Atlassian plugins for Bamboo and Stash to ease managing package building - Cron job for automatic build of public packages mirrored from [Packagist](https://packagist.org/) Installation ------------ [](#installation) You can install SCP directly with Composer by running ``` composer create-project realshadow/satis-control-panel [--stability-dev] ``` After that you can rename `example.env` to `.env` and set required configuration options. ### Building javascript [](#building-javascript) ``` npm run build // or npm run build-win ``` During development you can start Webpack dev server with ``` npm start ``` or run Gulp watcher for `less` files with ``` gulp watch ``` ### Satis configuration file [](#satis-configuration-file) In `resources/` directory you will find `satis.json.dist` file which holds default Satis configuration, copy this file and rename it to `satis.json` and edit the `name` and `homepage` property. ``` cp resources/satis.json.dist resources/satis.json ``` When you are done, you have to set correct permissions for your configuration file for web user. E.g. www-data, should be able to read/write this file). More in next *Permissions* section. ### Permissions [](#permissions) For building to work correctly you have to set correct permissions to few directories/directories: - bootstrap/cache/ - storage/ - public/private/ - public/public/ - resources/satis.json Each directory/file should be readable/writable by web user, e.g. www-data. For example: ``` chmod -R ug+rwx bootstrap/cache storage public/private public/public chmod ug+rwx resources/satis.json ``` Webserver setup --------------- [](#webserver-setup) Your document root should point to the `public` folder in the root as per default Laravel setup ### Apache - example vhost [](#apache---example-vhost) ``` ServerName satis.example.com DocumentRoot /var/www/html/satis.example.com/public ``` ### Nginx - example vhost [](#nginx---example-vhost) ``` server { listen 80 default_server; root /var/www/html/satis.example.com/public; index index.php index.html index.htm; location / { try_files $uri $uri/ /index.php$is_args$args; } # pass the PHP scripts to FastCGI server liste_ning on /var/run/php5-fpm.sock location ~ \.php$ { try_files $uri /index.php =404; fastcgi_pass unix:/var/run/php5-fpm.sock; fastcgi_index index.php; fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; include fastcgi_params; } } ``` ### Visiting your control panel and generated packages [](#visiting-your-control-panel-and-generated-packages) The control panel is located at `http://{host}/control-panel` and the packages will be generated (after first build of course) at `http://{host}/public`and `http://{host}/private` respectively. Separating them like this adds a bit more configuration options. If for example you want to only use private packages, you can change the directory of `private_repository` configuration option to `public` instead of `public/private` and have your packages generated at `http://{host}` and still have a functioning control panel. Configuration options --------------------- [](#configuration-options) Here is a list of configuration options that can be set in `config/satis.php` (some of them can be set in `.env` file as well for convenience): OptionDescriptionDefault valueCan be set in `.env`configPath to satis configuration fileresources/satis.jsonYescomposer\_homeComposer home directory (thistorage/composerYescomposer\_cacheComposer cache directorystorage/composer/cacheYesmemory\_limitMemory limit that will be set before running Satis build command2GNobuild\_verbosityVerbosity of Satis build command (more info will be stored in logs)vvvNoprivate\_repositoryDirectory where Satis will generate private repository. This also serves as a way to distinguish public and private repositories in repository address, e.g. satis.example.com/privateprivateNopublic\_repositoryDirectory where Satis will generate public repository. This also serves as a way to distinguish public and private repositories in repository address, e.g. satis.example.com/publicpublicNoproxy.httpProxy address that will be used by Satis/Composer for HTTP requestsnullYesproxy.httpsProxy address that will be used by Satis/Composer for HTTPS requestsnullYesproxy.httpsSee for detailsnullYes**Note:** if you change the default directory, remember to set correct permissions for your new directory. How it works ------------ [](#how-it-works) SCP manages a single Satis configuration file which is generated on the fly when specific UI actions are performed. During each generation cycle the file is split into public and private repository configuration file, because private packages use funcionality that doesn't work well with Packagist (it will try to mirror whole Packagist repository). Besides adding, editing and removing packages/repositories from configuration file, UI allows you to build/rebuild every package or run a complete rebuild of all registered packages/repositories. Build process can run synchronously or asynchronously (by redirecting output to `/dev/null` and spawning a new process). By default, all builds run asynchronously, except on Windows where they are forced to run synchronously. This can be also forced during during API request by setting `async_mode` to `false`. ### Missing or broken mirrored configuration files [](#missing-or-broken-mirrored-configuration-files) Since the configuration files mirroring is triggered by any UI action, it is not always the correct behaviour. If you want to manually trigger config generation, for example when you make changes directly on the server, you can trigger the config generation with this artisan command ``` php artisan satis:make:config ``` ### UI State [](#ui-state) During build process whole UI is locked. During asynchronous builds UI state is handled by Node server, but running it is completely optional. It can be started with ``` npm run server ``` and will run on port `9010` by default. This can be changed in `node/config.json` file. If for some reason UI will stay locked even though no packages are currently being build, it can be unlocked by running: ``` php artisan satis:persister:unlock ``` ### Composer auth [](#composer-auth) Composer file `auth.json` can be put in `COMPOSER_HOME` directory where you can put your Github token or credentials for needed for private repositories. ### Private packages [](#private-packages) Private packages are identified by repository URL address. When you will add/edit a new repository you can choose its type. By default, all repositories are considered as `VCS` repository. Building and rebuilding is handled by `partial update`functionality introduced in [this PR](https://github.com/composer/satis/pull/266) only repositories that have a URL can be managed in UI. Those include: - vcs - hg - pear - composer - artifact - path Adding support for more repository types is planned in future. Private packages use the `repositories` config key with `require-all` options set to `true`, thus all known packages are taken out of registered repositories, which means that Packagist must be disabled by default. This is handled when configs are split into private public part. ### Public (packagist) packages [](#public-packagist-packages) Public packages are used for mirroring of existing packages that can be installed from Packagist if you are behind a corporate proxy, thus speeding up overall development and deployment time. All packages added here are *fully* mirrored with all their dependencies (but we still skip `dev-dependencies`). Currently only one version constraint is used and that's `*` so we can get a complete packagist clone. Adding support for custom version constraints is planned in future. Since full rebuild in this case could potentionally take few hours, you can use provided Cron task for a daily rebuild (see *Cron task* section). **Note though that you should not try to mirror whole Packagist repository!** RESTful API ----------- [](#restful-api) SCP comes with built in API for esier integration with your favorite CI solution. ### Private packages [](#private-packages-1) Private packages use `md5` encoded repository url as ID. - get all repositories ``` GET control-panel/api/repository ``` - get one repository ``` GET control-panel/api/repository/{repository_id} ``` - add new repository ``` POST control-panel/api/repository { 'url': 'foo', 'type: 'bar' } ``` - update existing repository ``` PUT control-panel/api/repository/{repository_id} { 'url': 'foo', 'type: 'bar' } ``` - delete existing repository ``` DELETE control-panel/api/repository/{repository_id} ``` All methods return `HTTP 404` if no repository is found. **Note:** same API can be used for public packages as well by replacing `repository` by `package`. Although remote control of public packages is not necessary. ### Additional API options [](#additional-api-options) During both `POST` and `PUT` requests two additional options can be provided: - **async\_mode** - *true/false* => if the build should run synchronously or asynchronously (all builds run asynchronously by default) - **disable\_build** - *true/false* => if set to `true` Satis build command won't be run Logs ---- [](#logs) All logs can be found in `storage/logs` directory. Logs are divided into: - *api\_request.log* - logs all API requests - *builder\_async.log* - logs all builds that run asynchronously, keep in mind that each asynchronous build has its own log file in `async` subdirectory identified by its timestamp - *builder\_sync.log* - logs all builds that run synchronously - *cron.log* - for cron task logs Cron task --------- [](#cron-task) Since mirroring of public packages can take some time and running full rebuild from UI is not a good idea, because this will lock it during the build process, SCP comes with a built in cron task that runs daily and will rebuild all repositories. It can be triggered with a cron entry similar to this: ``` * * * * * php /path/to/satis-folder/artisan schedule:run >> /dev/null 2>&1 ``` Alternatively, you can add this cron entry: ``` 00 00 * * * curl --request POST --header "Content-Length: 0" --header "X-Requested-With: XMLHttpRequest" http://{scp-url-address}/control-panel/build-public ``` This can be used for private packages as well ``` 00 00 * * * curl --request POST --header "Content-Length: 0" --header "X-Requested-With: XMLHttpRequest" http://{scp-url-address}/control-panel/build-private ``` Atlassian plugins ----------------- [](#atlassian-plugins) SCP was created in an environment which uses Atlassian Stash and Bamboo as part of CI and thus two plugins were needed to completely integrate Composer packages into our build process. - [Stash Satis Build Hook](https://github.com/realshadow/stash-satis-build-hook.git) - a post receive hook that will register and trigger a build/rebuild of your package in SCP (if you want to skip deployment process) - [Bamboo Satis Build](https://github.com/realshadow/bamboo-satis-build.git) - a deployment task for rebuilding currently deployed Composer package in Satis repository Both use `partial update` functionality which was introduced in [this PR](https://github.com/composer/satis/pull/266). TODO ---- [](#todo) - option to import composer.lock file for public packages - option to use more types of private packages - option to write custom version constraints for public packages - option to see what's going during long running builds of public packages - better handling of race conditions during simultaneous writes/reads - authentification? (this can be simply handled with htpasswd) - ???? PR's are welcome Alternatives ------------ [](#alternatives) - [Satis Go](https://github.com/benschw/satis-go) - [Toran proxy](https://toranproxy.com/) ### Health Score 37 — LowBetter than 81% of packages Maintenance19 Infrequent updates — may be unmaintained Popularity34 Limited adoption so far Community21 Small or concentrated contributor base Maturity64 Established project with proven stability Bus Factor1 Top contributor holds 82% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~96 days Recently: every ~112 days Total 10 Last Release 2928d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/f031a679e7413a3d8be4b8f345524670bd0510b7e13ffbafc33a13b54bdf64c3?d=identicon)[realshadow](/maintainers/realshadow) --- Top Contributors [![realshadow](https://avatars.githubusercontent.com/u/6673222?v=4)](https://github.com/realshadow "realshadow (50 commits)")[![neilime](https://avatars.githubusercontent.com/u/314088?v=4)](https://github.com/neilime "neilime (5 commits)")[![mattzuba](https://avatars.githubusercontent.com/u/1494713?v=4)](https://github.com/mattzuba "mattzuba (3 commits)")[![antonkomarev](https://avatars.githubusercontent.com/u/1849174?v=4)](https://github.com/antonkomarev "antonkomarev (1 commits)")[![dubrsl](https://avatars.githubusercontent.com/u/943410?v=4)](https://github.com/dubrsl "dubrsl (1 commits)")[![freezysko](https://avatars.githubusercontent.com/u/661637?v=4)](https://github.com/freezysko "freezysko (1 commits)") --- Tags composercomposer-packagescontrol-panelproxyrepository-managementsatiscomposerproxysatiscontrol panelpackagist proxysatis proxy ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/realshadow-satis-control-panel/health.svg) ``` [![Health](https://phpackages.com/badges/realshadow-satis-control-panel/health.svg)](https://phpackages.com/packages/realshadow-satis-control-panel) ``` ### Alternatives [backpack/crud Quickly build admin interfaces using Laravel, Bootstrap and JavaScript. 3.4k3.7M220](/packages/backpack-crud)[statamic-rad-pack/runway Eloquently manage your database models in Statamic. 135224.7k7](/packages/statamic-rad-pack-runway)[exceedone/exment Management for Product, Client, Contracts, Subscription, ... 28038.3k](/packages/exceedone-exment)[playbloom/satisfy Satis composer repository manager with a Web UI 54810.6k](/packages/playbloom-satisfy) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)