https://github.com/mirrorhub-io/platform
Mirrorhub base API (Lineageos mirror #1)
https://github.com/mirrorhub-io/platform
api docker docker-compose grpc http mirror mirrors mit protobuf quay rest rest-api
Last synced: 27 days ago
JSON representation
Mirrorhub base API (Lineageos mirror #1)
- Host: GitHub
- URL: https://github.com/mirrorhub-io/platform
- Owner: mirrorhub-io
- License: mit
- Created: 2017-01-24T21:57:48.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-07T18:31:55.000Z (almost 9 years ago)
- Last Synced: 2025-03-25T16:44:45.620Z (11 months ago)
- Topics: api, docker, docker-compose, grpc, http, mirror, mirrors, mit, protobuf, quay, rest, rest-api
- Language: Go
- Homepage: https://mirrorhub.io
- Size: 10.6 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mirrorhub.io Platform
[](https://goreportcard.com/report/github.com/mirrorhub-io/platform)
[](https://quay.io/repository/mirrorhub/platform)
[](https://codebeat.co/projects/github-com-mirrorhub-io-platform)
[](https://godoc.org/github.com/mirrorhub-io/platform)
Our goal is to provide MirrorAsAService for everybody. Everybody knows it, you're running an application stack and you don't care about traffic. It is not as much to provide anybody a mirroring functionality but it wouldn't hurt to do.
We are trying to provide you as soon as possible a full stack solution which allows you to stop or hold mirroring at any time you want, with configurable traffic and storage limits. Possibly you want to support any open source project with up to 100GB storage but your are only able to provide 30% of them.
**Coming soon**
## CLI
### Installation
Download latest prebuilt binaries package. Select the correct binary and just run it.
```
Mirrorhub root command.
Usage:
mirrorhub [command]
Available Commands:
api Start mirrorhub api
autocomplete Generate shell autocompletion script for Mirrorhub
client Mirrorhub API-Client
gateway Start mirrorhub rest-gateway
Flags:
--config string config file (default is $HOME/.mirrorhub.yaml)
Use "mirrorhub [command] --help" for more information about a command.
```
A config could looks like the following.
```yaml
Email: huimoo@example.org
Password: supersecurepassword
API:
base: localhost:9000
```
## API
**Checkout protocol buffers under controllers/proto/api.proto**
Authorize (HTTP-Header) from Client
```
Grpc-Metadata-ClientToken:
```
Authorize (HTTP-Header) from Frontend
```
Grpc-Metadata-ContactToken:
```