Browse Source

README appropriate for github and dockerhub

Managing a single README is easier than maintaining two
Bryan 3 years ago
parent
commit
475bd0ea5b
1 changed files with 120 additions and 49 deletions
  1. 120
    49
      README.md

+ 120
- 49
README.md View File

@@ -1,18 +1,117 @@
1
-#docker-aptly
1
+docker-aptly
2
+==
3
+
4
+aptly in a container backed by nginx
5
+
6
+>aptly is a swiss army knife for Debian repository management: it allows you to mirror remote repositories, manage local package repositories, take snapshots, pull new versions of packages along with dependencies, publish as Debian repository. [aptly.info](http://aptly.info)
7
+
8
+>nginx [engine x] is an HTTP and reverse proxy server, a mail proxy server, and a generic TCP proxy server, originally written by Igor Sysoev [nginx.org](http://nginx.org/en/)
9
+
10
+Quickstart
11
+--
12
+
13
+The following command will run aptly and nginx in a container, if you want to customize or build the container locally, skip to [Building the Container](#building-the-container) below
14
+
15
+```
16
+docker run                                               \
17
+  --detach=true                                          \
18
+  --log-driver=syslog                                    \
19
+  --name="aptly"                                         \
20
+  --restart=always                                       \
21
+  --env FULL_NAME="First Last"                           \
22
+  --env EMAIL_ADDRESS="youremail@example.com"            \
23
+  --env GPG_PASSWORD="PickAPassword"                     \
24
+  --env HOSTNAME=aptly.example.com                       \
25
+  --volume /dockerhost/dir/with/lots/of/space:/opt/aptly \
26
+  --publish 80:80                                        \
27
+  bryanhong/aptly:latest
28
+```
29
+
30
+### Runtime flags explained
31
+
32
+```
33
+--detach=true
34
+```  
35
+run the container in the background  
36
+```
37
+--log-driver=syslog
38
+```  
39
+send nginx logs to syslog on the Docker host  (requires Docker 1.6 or higher)  
40
+```
41
+--name="aptly"
42
+```  
43
+name of the container  
44
+```
45
+--restart=always
46
+```  
47
+automatically start the container when the Docker daemon starts  
48
+```
49
+--env FULL_NAME="First Last"
50
+```  
51
+the first and last name that will be associated with the GPG apt signing key  
52
+```
53
+--env EMAIL_ADDRESS="youremail@example.com"
54
+```  
55
+the email address that will be associated with the GPG apt signing key  
56
+```
57
+--env GPG_PASSWORD="PickAPassword"
58
+```  
59
+the password that will be used to encrypt the GPG apt signing key  
60
+```
61
+--env HOSTNAME=aptly.example.com
62
+```  
63
+the hostname of the Docker host that this container is running on  
64
+```
65
+--volume /dockerhost/dir/with/lots/of/space:/opt/aptly
66
+```  
67
+path that aptly will use to store its data : mapped path in the container  
68
+```
69
+--publish 80:80
70
+```  
71
+Docker host port : mapped port in the container
72
+
73
+Create a mirror of Ubuntu's main repository
74
+--
75
+1. The initial download of the repository may take quite some time depending on your bandwidth limits, it may be in your best interest to open a screen or tmux session before proceeding.
76
+2. Attach to the container ```docker exec -it aptly /bin/bash```
77
+3. By default, ```/opt/update_mirror.sh``` will automate the creation of an Ubuntu 14.04 Trusty repository with the main and universe components, you can adjust the variables in the script to suit your needs.
78
+4. Run ```/opt/update_mirror.sh```
79
+5. If the script fails due to network disconnects etc, just re-run it.
80
+
81
+When the script completes, you should have a functional mirror that you can point a client to.
82
+
83
+Point a host at the mirror
84
+--
2 85
 
3
-Dockerfile and support scripts to run aptly in a container backed by nginx.
86
+1. Fetch the public PGP key from your aptly repository and add it to your trusted repositories
87
+
88
+ ```
89
+ wget http://FQDN.OF.APTLY/aptly_repo_key.pub
90
+ apt-key add aptly_repo_key.pub
91
+ ```
92
+
93
+2. Backup then replace /etc/apt/sources.list
4 94
 
5
-from [aptly.info](http://aptly.info): 
6
->aptly is a swiss army knife for Debian repository management: it allows you to mirror remote repositories, manage local package repositories, take snapshots, pull new versions of packages along with dependencies, publish as Debian repository.
95
+ ```
96
+ cp /etc/apt/sources.list /etc/apt/sources.list.bak
97
+ echo "deb http://FQDN.OF.APTLY/ ubuntu main" > /etc/apt/sources.list
98
+ apt-get update
99
+ ```
100
+ 
101
+ You should be able to install packages at this point!
102
+ 
103
+Checkout the excellent aptly documentation [here](http://www.aptly.info/doc/overview/)
7 104
 
8
-If you don't plan on customizing the Dockerfile in this repository, simply follow the instructions [here](https://hub.docker.com/r/bryanhong/aptly/) instead.
105
+Building the container
106
+--
9 107
 
10
-##Requirements / Dependencies
108
+If you want to make modifications to the image or simply see how things work, check out this repository:
11 109
 
12
-* Docker 1.6 or higher, we are using the Docker syslog driver in this container and this feature made its debut in 1.6
13
-* ```vars``` needs to be populated with the appropriate variables.
110
+```
111
+git clone https://github.com/bryanhong/docker-aptly.git
112
+```
14 113
 
15
-##Commands and variables
114
+### Commands and variables
16 115
 
17 116
 * ```vars```: Variables for Docker registry, the application, and aptly repository data location
18 117
 * ```build.sh```: Build the Docker image locally
@@ -20,61 +119,33 @@ If you don't plan on customizing the Dockerfile in this repository, simply follo
20 119
 * ```push.sh```: Pushes the latest locally built image to the repository set in vars
21 120
 * ```shell.sh```: get a shell within the container
22 121
 
23
-##How this image/container works
122
+### How this image/container works
123
+
124
+**Data**  
125
+All of aptly's data (including PGP keys and GPG keyrings) is bind mounted outside of the container to preserve it if the container is removed or rebuilt. Set the location for the bind mount in ```vars``` before starting the container. If you're going to host a mirror of Ubuntu's main repository, you'll need upwards of 80GB+ (x86_64 only) of free space as of Feb 2016, plan for growth.
24 126
 
25
-####Data
26
-All of aptly's data (including PGP keys and GPG keyrings) is bind mounted outside of the container to preserve it if the container is removed or rebuilt. Set the location for the bind mount in ```vars``` before starting the container. If you're going to host a mirror of Ubuntu's main repository, you'll need upwards of 35GB of free space as of Feb 2016, plan for growth.
27
-####Networking
127
+**Networking**  
28 128
 By default, Docker will map port 80 on the Docker host to port 80 within the container where nginx is configured to listen. You can change the external listening port in ```vars``` to map to any port you like.
29
-####Security
129
+
130
+**Security**  
30 131
 The GPG password you set in ```vars``` is stored in plain text and is visible as an environment variable inside the container. It is set as an enviornment variable to allow for automation of repository updates without user interaction. The GPG password can be removed completely but it is safer to encrypt the GPG keyrings because they are bind mounted outside the container to avoid the necessity of regenerating/redistributing keys if the container is removed or rebuilt.
31 132
 
32
-##Usage
133
+### Usage
33 134
 
34
-####Configure the container
135
+#### Configure the container
35 136
 
36 137
 1. Configure application specific variables in ```vars```
37 138
 
38
-####Build the image
139
+#### Build the image
39 140
 
40 141
 1. Run ```./build.sh```
41 142
 
42
-####Start the container
143
+#### Start the container
43 144
 
44 145
 1. Run ```./run.sh```
45 146
 2. Wait until the GPG keyrings are created (not 0 bytes) before proceeding (it can take a few minutes). They will be in the bind mount location you chose in ```vars```
46
-
47
-####Create a mirror of Ubuntu's main repository
48
-1. The initial download of the repository may take quite some time depending on your bandwidth limits, it may be in your best interest to open a tmux or screen session before proceeding.
49
-2. Attach to the container ```./shell.sh```
50
-3. By default, ```/opt/update_mirror.sh``` will automate the creation of an Ubuntu 14.04 Trusty repository, if you want a different release, modify the variables in the script.
51
-4. Run ```/opt/update_mirror.sh```
52
-5. If the script fails due to network disconnects etc, just re-run it.
53
-
54
-When the script completes, you should have a functional mirror that you can point a client to.
55
-
56
-####Point a host at the mirror
57
-
58
-1. Fetch the public PGP key from your aptly repository and add it to your trusted repositories
59
-
60
- ```
61
- wget http://FQDN.OF.APTLY/aptly_repo_signing.key
62
- apt-key add aptly_repo_signing.key
63
- ```
64
-
65
-2. Backup then replace /etc/apt/sources.list
66
-
67
- ```
68
- cp /etc/apt/sources.list /etc/apt/sources.list.bak
69
- echo "deb http://FQDN.OF.APTLY/ RELEASE_NAME main" > /etc/apt/sources.list
70
- apt-get update
71
- ```
72
- 
73
- You should be able to install packages at this point!
74
- 
75
-Checkout the excellent aptly documentation [here](http://www.aptly.info/doc/overview/)
76 147
  
77
-####Pushing your image to the registry
148
+#### Pushing your image to the registry
78 149
 
79 150
 If you're happy with your container and ready to share with others, push your image up to a [Docker registry](https://docs.docker.com/docker-hub/) and save any other changes you've made so the image can be easily changed or rebuilt in the future.
80 151
 

Loading…
Cancel
Save