mirror of
https://gitee.com/goploy/goploy.git
synced 2024-12-02 04:07:33 +08:00
A docker support
This commit is contained in:
zhenorzz
parent
fafa740330
commit
7a21d628e9
@ -28,6 +28,8 @@ Complete installation instructions, no difficulty in getting started!
|
||||
|
||||
[DEMO](http://demo.goploy.icu) admin:admin!@# (It may not be able to open, depending on the mood)
|
||||
|
||||
[Docker](https://hub.docker.com/r/zhenorzz/goploy)
|
||||
|
||||
[Document](https://docs.goploy.icu)
|
||||
|
||||
## Content
|
||||
|
||||
@ -28,6 +28,8 @@
|
||||
|
||||
[DEMO](http://demo.goploy.icu) admin:admin!@# (不一定能打开，看心情)
|
||||
|
||||
[Docker](https://hub.docker.com/r/zhenorzz/goploy)
|
||||
|
||||
[帮助文档](https://docs.goploy.icu)
|
||||
|
||||
## 内容列表
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<p align=center>
|
||||
<img src="../banner.png" alt="logo" title="logo" />
|
||||
<img src="https://github.com/zhenorzz/goploy/blob/master/banner.png" alt="logo" title="logo" />
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
@ -8,7 +8,7 @@
|
||||
</a>
|
||||
<a href="#">
|
||||
<img src="https://img.shields.io/badge/give%20me-a%20star-green.svg" alt="STAR">
|
||||
</a>
|
||||
</a>
|
||||
<a href="../LICENSE">
|
||||
<img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="LICENSE">
|
||||
</a>
|
||||
@ -24,18 +24,17 @@ Complete installation instructions, no difficulty in getting started!
|
||||
|
||||
# How to use?
|
||||
|
||||
Simply build the image using `docker build -t readme-to-hub .`
|
||||
|
||||
and run it with all needed parameter:
|
||||
run it with all needed parameter:
|
||||
|
||||
```console
|
||||
docker run --rm \
|
||||
-v /path/to/readme.md:/data/README.md \
|
||||
-e DOCKERHUB_USERNAME=myhubuser \
|
||||
-e DOCKERHUB_PASSWORD=myhubpassword \
|
||||
-e DOCKERHUB_REPO_PREFIX=myorga \
|
||||
-e DOCKERHUB_REPO_NAME=myrepo \
|
||||
readme-to-hub
|
||||
-p 3000:80 \
|
||||
-v /path/to/.ssh:/root/.ssh \
|
||||
-v /path/to/hosts:/etc/hosts \
|
||||
-e MYSQL_HOST=mysql \
|
||||
-e MYSQL_USER=root \
|
||||
-e MYSQL_PASSWORD=password \
|
||||
zhenorzz/goploy
|
||||
```
|
||||
|
||||
That's it.
|
||||
@ -47,65 +46,42 @@ This image uses environment variables for configuration.
|
||||
|
||||
|Available variables |Default value |Description |
|
||||
|------------------------|---------------------|----------------------------------------------------|
|
||||
|`DOCKERHUB_USERNAME` |no default |The Username (not mail address) used to authenticate|
|
||||
|`DOCKERHUB_PASSWORD` |no default |Password of the `DOCKERHUB_USERNAME`-user |
|
||||
|`DOCKERHUB_REPO_PREFIX` |`$DOCKERHUB_USERNAME`|Organization or username for the repository |
|
||||
|`DOCKERHUB_REPO_NAME` |no default |Name of the repository you want to push to |
|
||||
|`README_PATH` |`/data/README.md` |Path to the README.me to push |
|
||||
|`SHORT_DESCRIPTION` |no default |Short description for the Dockerhub repo |
|
||||
|`MYSQL_HOST` |no default |MYSQL HOST|
|
||||
|`MYSQL_PORT` |3306 |MYSQL PORT|
|
||||
|`MYSQL_USER` |no default |MYSQL USER|
|
||||
|`MYSQL_PASSWORD` |no default |MYSQL PASSWORD|
|
||||
|
||||
## Mount the README.md
|
||||
## Mount
|
||||
|
||||
By default, if the `README_PATH` environment variable is not set, this image always pushes the file
|
||||
`/data/README.md` as full description to Docker Hub.
|
||||
The rsync and ssh need id_rsa to conncet server, so you have to mount your ssh path to container using `-v /path/to/.ssh:/root/.ssh`.
|
||||
|
||||
For GitHub repositories you can use `-v /path/to/repository:/data/`.
|
||||
If you want to access your own domain in container, you should mount your hosts file to container using `-v /path/to/hosts:/etc/hosts`.
|
||||
|
||||
If your description is not named `README.md` mount the file directory using `-v /path/to/description.md:/data/README.md`.
|
||||
If you would like to keep the repositories you can use `-v /path/to/repository:/opt/goploy/repository`.
|
||||
|
||||
*Notice that the filename is case sensitive. If your readme is called `readme.md` you have to mount the file directly, not the directory*
|
||||
|
||||
|
||||
# Additional Information
|
||||
|
||||
The user you use to push the README.md need to be admin of the repository.
|
||||
|
||||
|
||||
# Implementations and references of this image
|
||||
|
||||
* [InspIRCd](https://github.com/Adam-/inspircd-docker/blob/master/.travis.yml)
|
||||
* [Anope](https://github.com/Adam-/anope-docker/blob/master/.travis.yml)
|
||||
* [Minecraft](https://github.com/SISheogorath/minecraft-docker/blob/master/.travis.yml)
|
||||
* [isso](https://github.com/SISheogorath/isso-docker/blob/master/.travis.yml)
|
||||
|
||||
[Windows id_rsa permission denied, click this for help.](https://stackoverflow.com/questions/9270734/ssh-permissions-are-too-open-error)
|
||||
|
||||
# Updates and updating
|
||||
|
||||
To update your setup simply pull the newest image version from docker hub and run it.
|
||||
|
||||
|
||||
## Deprecated features
|
||||
|
||||
We provide information about features we remove in future.
|
||||
|
||||
* `DOCKERHUB_REPO` - is renamed to `DOCKERHUB_REPO_NAME` to be not mixed up with `DOCKERHUB_REPO_PREFIX`
|
||||
|
||||
|
||||
# License
|
||||
|
||||
View [license information](https://www.npmjs.com/package/docker-hub-api) for the software contained in this image.
|
||||
View [license information](https://github.com/zhenorzz/goploy/blob/master/LICENSE) for the software contained in this image.
|
||||
|
||||
Everything in [this repository](https://github.com/SISheogorath/readme-to-dockerhub) is published under [GPL-3](https://spdx.org/licenses/GPL-3.0).
|
||||
Everything in [this repository](https://github.com/zhenorzz/goploy) is published under [MIT](https://spdx.org/licenses/MIT).
|
||||
|
||||
# User Feedback
|
||||
|
||||
## Issues
|
||||
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/SISheogorath/readme-to-dockerhub/issues).
|
||||
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/zhenorzz/goploy/issues).
|
||||
|
||||
|
||||
## Contributing
|
||||
|
||||
You are invited to contribute new features, fixes, or updates, large or small; I'm always thrilled to receive pull requests.
|
||||
|
||||
General guidelines for development can be found at https://shivering-isles.com/contribute
|
||||
|
||||
@ -23,6 +23,10 @@ Download releases
|
||||
- https://github.com/zhenorzz/goploy/releases
|
||||
- https://gitee.com/goploy/goploy/releases
|
||||
|
||||
Method 3:
|
||||
|
||||
[Docker](https://hub.docker.com/r/zhenorzz/goploy)
|
||||
|
||||
# Start up
|
||||
|
||||
```shell
|
||||
|
||||
@ -23,6 +23,10 @@ go get -u github.com/zhenorzz/goploy
|
||||
- https://github.com/zhenorzz/goploy/releases
|
||||
- https://gitee.com/goploy/goploy/releases
|
||||
|
||||
方法3：
|
||||
|
||||
[Docker](https://hub.docker.com/r/zhenorzz/goploy)
|
||||
|
||||
# 启动
|
||||
|
||||
```shell
|
||||
|
||||
Loading…
Reference in New Issue
Block a user