Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/repman-io/repman
Repman - PHP Repository Manager: packagist proxy and host for private packages
https://github.com/repman-io/repman
composer hacktoberfest packagist packagist-mirror packagist-proxy php private-packagist repository-management
Last synced: 6 days ago
JSON representation
Repman - PHP Repository Manager: packagist proxy and host for private packages
- Host: GitHub
- URL: https://github.com/repman-io/repman
- Owner: repman-io
- License: mit
- Created: 2020-03-12T08:40:23.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-08T15:03:43.000Z (7 months ago)
- Last Synced: 2025-01-10T21:03:30.198Z (13 days ago)
- Topics: composer, hacktoberfest, packagist, packagist-mirror, packagist-proxy, php, private-packagist, repository-management
- Language: PHP
- Homepage: https://repman.io
- Size: 2.2 MB
- Stars: 525
- Watchers: 13
- Forks: 107
- Open Issues: 111
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Repman - PHP Repository Manager
[](https://php.net/)
[](https://stats.uptimerobot.com/QAMQli6XQM)
[](https://app.buddy.works/repman/repman/pipelines/pipeline/244549)
[](https://codecov.io/gh/repman-io/repman)
[](https://hitsofcode.com/view/github/repman-io/repman)
[](https://codeclimate.com/github/repman-io/repman/maintainability)
[](https://hub.docker.com/r/buddy/repman)
**Repman** is a PHP repository manager. Main features:
- free and open source
- works as a proxy for **packagist.org** (speeds up your local builds)
- hosts your private packages
- allows to create individual access tokens
- supports private package import from **GitHub**, **GitLab** and **Bitbucket** with one click
- REST API
- security scanner (with e-mail reports)
Documentation: [https://repman.io/docs/](https://repman.io/docs/)
## Requirements
- PHP >= 7.4
- PostgreSQL 11
- `var` dir must be writeable
- any web server
## Installation
### Docker
[https://repman.io/docs/standalone/#docker-installation](https://repman.io/docs/standalone/#docker-installation)
### Ansible
[https://repman.io/docs/standalone/#ansible-playbooks-installation](https://repman.io/docs/standalone/#ansible-playbooks-installation)
### Manual
```bash
git clone [email protected]:repman-io/repman.git
cd repman
composer install
```
Setup database:
```
bin/console doctrine:migrations:migrate #for postgres
bin/console doctrine:schema:create #for sqlite init as migrations are only postgres-compatible
bin/console messenger:setup-transports
```
## Configuration
### Mailer
To configure mailer transport, enter connection details in the `MAILER_DSN` environment variable
```
MAILER_DSN=smtp://user:[email protected]
```
Read more: [transport setup](https://symfony.com/doc/current/mailer.html#transport-setup)
In addition, setup also `MAILER_SENDER` environment variable
```
[email protected]
```
## Workers
To process messages asynchronously you must run worker:
```bash
bin/console messenger:consume async
```
Read more: [deploying to production](https://symfony.com/doc/current/messenger.html#deploying-to-production)
## Usage
Navigate your browser to instance address, you will see home page with usage instructions.
## Local proxy
On dev env you may want to enable proxy to allow to create subdomains and tests composer organizations:
```bash
composer proxy-setup
```
This will create `repman.wip` domain. Then you can add other domains with:
```bash
symfony proxy:domain:attach your-organization.repman
```
### CLI commands
- `bin/console repman:metadata:clear-cache` - clear packages metadata cache (json files)
- `bin/console repman:create:admin []` - create a new user with admin privileges
- `bin/console repman:create:user []` - create a new (normal) user
- `bin/console repman:proxy:sync-releases` - sync proxy releases with packagist.org
- `bin/console repman:security:scan-all` - scan all synchronized packages
- `bin/console repman:security:update-db` - update security advisories database, scan all packages if updated
- `bin/console repman:package:synchronize ` - synchronize given package
- `bin/console repman:package:clear-old-dists` - clear old private dev distributions files
## API Integration
Callbacks:
- `/auth/{provider}/check`
- `/register/{provider}/check`
- `/user/token/{provider}/check`
### GitHub
Scopes:
- registration: `user:email`
- repositories: `read:org`, `repo`
### GitLab
Scopes:
- registration: `read_user`
- repositories: `api`
### Bitbucket
Scopes:
- registration: `email`
- repositories: `repository`, `webhook`
## Self-hosted GitLab
To integrate with self-hosted GitLab, enter the instance url in the `APP_GITLAB_API_URL` environment variable
```
APP_GITLAB_API_URL='https://gitlab.organization.lan'
```
## Docker
- Override with `docker-compose.override.yml` if needed.
- Set your domain (`APP_HOST`) in `.env.docker`.
If you wish to use your own certificate put key and certificate in:
- `docker/nginx/ssl/private/server.key`
- `docker/nginx/ssl/certs/server.crt`
Otherwise self-sign certificate will be generated.
To start all containers run:
```bash
docker-compose up
```
## Support
In case of any problems, you can use:
- Our documentation: [repman.io/docs](https://repman.io/docs/) - it is also open sourced [github.com/repman-io/repman-docs-pages](https://github.com/repman-io/repman-docs-pages)
- GitHub issue list: [github.com/repman-io/repman/issues](https://github.com/repman-io/repman/issues) - feel free to create a new issue there
- E-mail: contact [at] repman.io
## License
The Repman project is licensed under the terms of the [MIT](LICENSE).
However, Repman includes several third-party Open-Source libraries, which are licensed under their own respective Open-Source licenses.
#### Libraries or projects directly included in Repman
- Tabler: [MIT](https://github.com/tabler/tabler/blob/master/LICENSE)
- Feather: [MIT](https://github.com/feathericons/feather/blob/master/LICENSE)
- Lucide: License: [ISC](https://github.com/lucide-icons/lucide/blob/master/LICENSE)
- Postmark Transactional Email Templates: [MIT](https://github.com/wildbit/postmark-templates/blob/master/LICENSE)
- Libraries dynamically referenced via Composer: run `composer license` to get the latest licensing info about all dependencies.
---
made with ❤️ by [Buddy](https://buddy.works)