Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ypereirareis/docker-satis
Docker image to run Satis (private packagist) with Satisfy User Interface. Crontab and manual build possibility
https://github.com/ypereirareis/docker-satis
composer docker docker-satis satis satisfy ui user-interface
Last synced: 15 days ago
JSON representation
Docker image to run Satis (private packagist) with Satisfy User Interface. Crontab and manual build possibility
- Host: GitHub
- URL: https://github.com/ypereirareis/docker-satis
- Owner: ypereirareis
- License: mit
- Created: 2015-03-17T10:16:55.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-01-11T11:31:51.000Z (almost 3 years ago)
- Last Synced: 2024-10-14T06:23:15.235Z (29 days ago)
- Topics: composer, docker, docker-satis, satis, satisfy, ui, user-interface
- Language: Shell
- Homepage: https://hub.docker.com/r/ypereirareis/docker-satis/
- Size: 104 KB
- Stars: 122
- Watchers: 7
- Forks: 51
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Docker Satis
[](https://app.travis-ci.com/github/ypereirareis/docker-satis)
[]()
[]()
A docker image and configuration to run [Satis](https://github.com/composer/satis) very easily in seconds
* Satisfy v3.4.0
* PHP 8.1 - `PHP 8.1.1 (cli) (built: Dec 20 2021 21:35:13) (NTS)`
* Debian 11 Bullseye
* nginx/1.18.0 - `built with OpenSSL 1.1.1k 25 Mar 2021`
* Composer 2 - `Composer version 2.2.3 2021-12-31 12:18:53`
## Requirements
* docker
* docker-compose
* make
## Install
```bash
cp .env.dist .env
cp config/parameters.satisfy.yml.dist config/parameters.satisfy.yml
cp config/satis.json.dist config/satis.json
make start
```
## The default config file for satis looks like this:
```json
{
"name": "company/private-packagist",
"homepage": "https:\/\/satis.domain.tld",
"output-dir": "web",
"output-html": true,
"repositories": [
],
"require-all": true,
"require-dependencies": true,
"require-dev-dependencies": true,
"include-filename": "include\/all$%hash%.json",
"minimum-stability": "dev",
"providers": false
}
```
## Service management
* **Start**
```
make start
```
* **Stop**
```
make stop
```
* **Remove**
```
make remove
```
* **Status**
```
make state
```
## Satis/Satisfy access
* Home page
[http://satis.localhost](http://satis.localhost)
* Manual build / Web hook
[http://satis.localhost/admin/satis/build](http://satis.localhost/admin/satis/build)
* Admin
[http://satis.localhost/admin](http://satis.localhost/admin)
Default credentials are : **admin / foo**
## **Build frequency**
* By default, building script is executed every minute thanks to the docker-compose configuration
```yml
satis:
image: ypereirareis/docker-satis:3.4.0-debian-bullseye-php81-composer2
environment:
CRONTAB_FREQUENCY: "*/1 * * * *"
```
* You can override this value changing the cron configuration: `*/5 * * * * OR */10 * * * *`
* Or you can disable cron with: `CRONTAB_FREQUENCY=-1`
## SSH key
* The container needs to know the ssh key you added in your private repo (and optionally your SSH configuration).
```yml
satis:
image: ypereirareis/docker-satis:3.4.0-debian-bullseye-php81-composer2
volumes:
- "~/.ssh/id_rsa:/var/tmp/id"
- "~/.ssh/config:/var/tmp/sshconf"
```
You could add the key into your own image but be careful your ssh key will be in the image (DO NOT SHARE THE IMAGE TO THE WORLD):
```Dockerfile
FROM ypereirareis/docker-satis:3.4.0-debian-bullseye-php81-composer2
...
ADD SSH_PATH/.ssh/id_rsa:/var/tmp/id
ADD SSH_PATH/.ssh/config:/var/tmp/sshconf
```
* The ssh fingerprints of private repos servers need to be added in the known_hosts file inside the container that's why we specify the URL through ENV variable.
**You can now add the ssh port of your server `yourownserver.com:54322` and it supports rsa and dsa keys**
```yml
satis:
image: ypereirareis/docker-satis:3.4.0-debian-bullseye-php81-composer2
environment:
PRIVATE_REPO_DOMAIN_LIST: bitbucket.org gitlab.com github.com yourownserver.com:54322
```
## Composer cache
Cache should be shared with the host to be reused when you restart the container, for better performance.
```yml
satis:
image: ypereirareis/docker-satis:3.4.0-debian-bullseye-php81-composer2
volumes:
- "/var/tmp/composer:/root/.composer"
```
## Outside world
If you want to give access satis to the outside world, you should use a reverse proxy.
Below is a working setup for NGINX:
```
server {
server_name satis.domain.tld;
location / {
proxy_pass http://127.0.0.1:80;
}
}
```
## Tests
```shell
./tests.sh
```
## LICENSE
The MIT License (MIT)
Copyright (c) 2017 Yannick Pereira-Reis
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.