go-repo/README.md

68 lines
1.2 KiB
Markdown
Raw Normal View History

2020-11-21 12:34:31 +00:00
# go-repo
*go-repo* is a simple golang repository hosting web app, heavily inspired by [go.uber.org](https://go.uber.org).
2020-11-21 12:42:39 +00:00
It allows hosting go modules with custom import names.
Example :
```bash
$ go get go.adphi.net/go-repo
```
instead of
```bash
$ go get git.adphi.net/adphi/go-repo
```
2020-11-21 12:34:31 +00:00
## Installation
```bash
$ docker pull adphi/go-repo
```
## Deployment
An example Kubernetes deployment is available in [the deploy directory](deploy/deploy.yml).
## Usage
```bash
$ go-repo
Usage:
go-repo [config] [flags]
Examples:
go-repo config.yml
Flags:
-a, --address string The server address (default ":8888")
-h, --help help for go-repo
--logs-level string (default "info")
```
An example config file:
```yaml
modules:
- import: go.adphi.net/go-repo
repository: git.adphi.net/adphi/go-repo
readme: git.adphi.net/adphi/go-repo/raw/master/README.md
```
The config file is reloaded on changes
Run the app:
```bash
$ go-repo config.yml
```
2020-11-21 12:42:39 +00:00
## Screenshots
The origin display the available packages index
![index](screenshots/index.png)
The details page display the README.md from configuration
![details](screenshots/details.png)