From 4b6c881695521ad90dcbf0e148cb306eafbb7c4a Mon Sep 17 00:00:00 2001 From: Terry Chen Date: Thu, 27 Apr 2017 14:50:33 +0800 Subject: [PATCH] update README.md --- README.md | 33 +++++++++++++-------------------- 1 file changed, 13 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index def4550..0d1eefe 100644 --- a/README.md +++ b/README.md @@ -3,29 +3,22 @@ [![Docker Stars](https://img.shields.io/docker/stars/seterrychen/apt-mirror-http-server.svg)](https://hub.docker.com/r/seterrychen/apt-mirror-http-server/) [![Docker Pulls](https://img.shields.io/docker/pulls/seterrychen/apt-mirror-http-server.svg)](https://hub.docker.com/r/seterrychen/apt-mirror-http-server/) -Base on Ubuntu, using Docker to construct your Apt mirror HTTP server +Using Docker to construct your APT(Advanced Packaging Tools) mirror HTTP server. ## Usage -Running command -``` -docker run -v /path/data:/var/spool/apt-mirror \ - -v /path/your/mirror.list:/etc/apt/mirror.list \ - -e TIMEOUT=timeout-value \ - -d -p port_number:80 seterrychen/apt-mirror-http-server -``` -/path/data is where to store data, and the TIMEOUT var to repeatedly execute apt-mirror. +### Basic command: -If you don't setting variable of mirror.list and TIMEOUT, it will using the [default mirror.list](mirror.list), and -the default TIMEOUT is 12 hours. To see the [TIMEOUT format description](http://www.cyberciti.biz/faq/linux-unix-sleep-bash-scripting/). - -Or running command ``` -docker run -v /path/data:/var/spool/apt-mirror \ - -e MIRROR_URL=http://tw.archive.ubuntu.com/ubuntu \ - -e TIMEOUT=timeout-value \ - -d -p port_number:80 seterrychen/apt-mirror-http-server +docker run -d \ + -v /path/data:/var/spool/apt-mirror \ + -p 8080:80 seterrychen/apt-mirror-http-server ``` -MIRROR_URL can used to replace apt sources of [default mirror.list](mirror.list) -## Note -It will take time to download, then start http server. Using ``docker logs -f container-id`` to check the process. +* `-v /path/data`: the path which you want to store data + + +### More options with docker command + +* `-v /path/your/mirror.list:/etc/apt/mirror.list`: to replace [Ubuntu default mirror.list](https://github.com/seterrychen/apt-mirror-http-server/blob/master/mirror.list) +* `-e MIRROR_URL=http://tw.archive.ubuntu.com/ubuntu`: to overwrite the mirror.list when you use this option to specific the mirror site +* `-e TIMEOUT=timeout-value`: to set the resync period, default is 12 hours. To set the [TIMEOUT format description](http://www.cyberciti.biz/faq/linux-unix-sleep-bash-scripting/)