{"id":13617901,"url":"https://github.com/ypereirareis/docker-satis","last_synced_at":"2025-03-17T02:31:27.767Z","repository":{"id":28862168,"uuid":"32386302","full_name":"ypereirareis/docker-satis","owner":"ypereirareis","description":"Docker image to run Satis (private packagist) with Satisfy User Interface. Crontab and manual build possibility","archived":false,"fork":false,"pushed_at":"2022-01-11T11:31:51.000Z","size":107,"stargazers_count":122,"open_issues_count":6,"forks_count":50,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-02-27T16:44:32.541Z","etag":null,"topics":["composer","docker","docker-satis","satis","satisfy","ui","user-interface"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/ypereirareis/docker-satis/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ypereirareis.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-03-17T10:16:55.000Z","updated_at":"2024-05-10T00:42:38.000Z","dependencies_parsed_at":"2022-09-07T23:13:24.883Z","dependency_job_id":null,"html_url":"https://github.com/ypereirareis/docker-satis","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ypereirareis%2Fdocker-satis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ypereirareis%2Fdocker-satis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ypereirareis%2Fdocker-satis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ypereirareis%2Fdocker-satis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ypereirareis","download_url":"https://codeload.github.com/ypereirareis/docker-satis/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243837011,"owners_count":20355813,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["composer","docker","docker-satis","satis","satisfy","ui","user-interface"],"created_at":"2024-08-01T20:01:50.099Z","updated_at":"2025-03-17T02:31:27.368Z","avatar_url":"https://github.com/ypereirareis.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# Docker Satis\n\n\n[![Build Status](https://app.travis-ci.com/ypereirareis/docker-satis.svg?branch=master)](https://app.travis-ci.com/github/ypereirareis/docker-satis)\n[![Docker Stars](https://img.shields.io/docker/stars/ypereirareis/docker-satis.svg)]()\n[![Docker Pulls](https://img.shields.io/docker/pulls/ypereirareis/docker-satis.svg)]()\n\nA docker image and configuration to run [Satis](https://github.com/composer/satis) very easily in seconds\n\n* Satisfy v3.4.0\n* PHP 8.1 - `PHP 8.1.1 (cli) (built: Dec 20 2021 21:35:13) (NTS)`\n* Debian 11 Bullseye\n* nginx/1.18.0 - `built with OpenSSL 1.1.1k  25 Mar 2021`\n* Composer 2 - `Composer version 2.2.3 2021-12-31 12:18:53`\n\n## Requirements\n\n* docker\n* docker-compose\n* make\n\n## Install\n\n```bash\ncp .env.dist .env\ncp config/parameters.satisfy.yml.dist config/parameters.satisfy.yml\ncp config/satis.json.dist config/satis.json\nmake start\n```\n\n## The default config file for satis looks like this:\n\n```json\n{\n    \"name\": \"company/private-packagist\",\n    \"homepage\": \"https:\\/\\/satis.domain.tld\",\n    \"output-dir\": \"web\",\n    \"output-html\": true,\n    \"repositories\": [\n    ],\n    \"require-all\": true,\n    \"require-dependencies\": true,\n    \"require-dev-dependencies\": true,\n    \"include-filename\": \"include\\/all$%hash%.json\",\n    \"minimum-stability\": \"dev\",\n    \"providers\": false\n}\n\n```\n\n## Service management\n\n* **Start**\n\n```\nmake start\n```\n\n* **Stop**\n\n```\nmake stop\n```\n\n* **Remove**\n\n```\nmake remove\n```\n\n* **Status**\n\n```\nmake state\n```\n\n## Satis/Satisfy access\n\n* Home page\n[http://satis.localhost](http://satis.localhost)\n\n* Manual build / Web hook\n[http://satis.localhost/admin/satis/build](http://satis.localhost/admin/satis/build)\n\n* Admin\n[http://satis.localhost/admin](http://satis.localhost/admin)\n\nDefault credentials are : **admin / foo** \n\n## **Build frequency**\n\n* By default, building script is executed every minute thanks to the docker-compose configuration\n\n```yml\nsatis:\n    image: ypereirareis/docker-satis:3.4.0-debian-bullseye-php81-composer2\n    environment:\n        CRONTAB_FREQUENCY: \"*/1 * * * *\"\n```\n\n* You can override this value changing the cron configuration: `*/5 * * * * OR */10 * * * *`\n* Or you can disable cron with: `CRONTAB_FREQUENCY=-1`\n\n## SSH key\n\n* The container needs to know the ssh key you added in your private repo (and optionally your SSH configuration).\n\n```yml\nsatis:\n    image: ypereirareis/docker-satis:3.4.0-debian-bullseye-php81-composer2\n    volumes:\n        - \"~/.ssh/id_rsa:/var/tmp/id\"\n        - \"~/.ssh/config:/var/tmp/sshconf\"\n```\n\nYou 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):\n\n```Dockerfile\nFROM ypereirareis/docker-satis:3.4.0-debian-bullseye-php81-composer2\n...\nADD SSH_PATH/.ssh/id_rsa:/var/tmp/id\nADD SSH_PATH/.ssh/config:/var/tmp/sshconf\n```\n\n* 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.\n\n**You can now add the ssh port of your server `yourownserver.com:54322` and it supports rsa and dsa keys**\n\n```yml\nsatis:\n    image: ypereirareis/docker-satis:3.4.0-debian-bullseye-php81-composer2\n    environment:\n        PRIVATE_REPO_DOMAIN_LIST: bitbucket.org gitlab.com github.com yourownserver.com:54322\n```\n\n## Composer cache\n\nCache should be shared with the host to be reused when you restart the container, for better performance.\n\n```yml\nsatis:\n    image: ypereirareis/docker-satis:3.4.0-debian-bullseye-php81-composer2\n    volumes:\n        - \"/var/tmp/composer:/root/.composer\"\n```\n\n\n## Outside world\n\nIf you want to give access satis to the outside world, you should use a reverse proxy.\n\nBelow is a working setup for NGINX:\n\n```\nserver {\n    server_name satis.domain.tld;\n\n    location / {\n        proxy_pass http://127.0.0.1:80;\n    }\n}\n```\n\n## Tests\n\n```shell\n./tests.sh\n```\n\n## LICENSE\n\nThe MIT License (MIT)\n\nCopyright (c) 2017 Yannick Pereira-Reis\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fypereirareis%2Fdocker-satis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fypereirareis%2Fdocker-satis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fypereirareis%2Fdocker-satis/lists"}