Browse Source

Update README.md

Mohammad Abdoli Rad 7 years ago
parent
commit
a71abff4f9
2 changed files with 89 additions and 3 deletions
  1. 9 2
      Dockerfile
  2. 80 1
      README.md

+ 9 - 2
Dockerfile

@@ -1,10 +1,17 @@
 FROM dockage/alpine:3.6
 MAINTAINER Mohammad Abdoli Rad <m.abdolirad@gmail.com>
 
+LABEL org.label-schema.name="alpine-openrc" \
+        org.label-schema.vendor="Dockage" \
+        org.label-schema.description="Docker image uses openRC as a process supervision on Alpine Linux" \
+        org.label-schema.vcs-url="https://github.com/dockage/alpine-openrc" \
+        org.label-schema.version="0.24.1" \
+        org.label-schema.license="MIT"
+
 RUN set -x \
-    && apk add --no-cache openrc \
+    && apk add --no-cache openrc=0.24.1-r2 \
     # Disable getty's
-    && sed -i 's/^\(tty\d\:\:\)/#\1/gp' /etc/inittab \
+    && sed -i 's/^\(tty\d\:\:\)/#\1/g' /etc/inittab \
     && sed -i \
         # Change subsystem type to "docker"
         -e 's/#rc_sys=".*"/rc_sys="docker"/g' \

+ 80 - 1
README.md

@@ -1 +1,80 @@
-# alpine-openrc
+# alpine-openrc [![Docker Pulls](https://img.shields.io/docker/pulls/dockage/alpine-openrc.svg?style=flat)](https://hub.docker.com/r/dockage/alpine-openrc/) [![Docker Stars](https://img.shields.io/docker/stars/dockage/alpine-openrc.svg?style=flat)](https://hub.docker.com/r/dockage/alpine-openrc/) [![MicroBadger](https://images.microbadger.com/badges/image/dockage/alpine-openrc.svg)](https://microbadger.com/images/dockage/alpine-openrc) [![Docker Automated build](https://img.shields.io/docker/automated/dockage/alpine-openrc.svg?style=flat)](https://hub.docker.com/r/dockage/alpine-openrc/)
+
+[OpenRC](https://en.wikipedia.org/wiki/OpenRC) is the default init system of [Gentoo](https://gentoo.org), [Alpine Linux](https://alpinelinux.org              ) and other Linux distributions, which means that the software packages and daemons of those distributions support it, coming with or using the available scripts.
+
+
+## Contributing
+
+If you find this image useful here's how you can help:
+
+- Send a pull request with your awesome features and bug fixes
+- Help users resolve their [issues](../../issues?q=is%3Aopen+is%3Aissue).
+
+## Issues
+
+Before reporting your issue please try updating Docker to the latest version and check if it resolves the issue. Refer to the Docker [installation guide](https://docs.docker.com/installation) for instructions.
+
+SELinux users should try disabling SELinux using the command `setenforce 0` to see if it resolves the issue.
+
+If the above recommendations do not help then [report your issue](../../issues/new) along with the following information:
+
+- Output of the `docker vers6` and `docker info` commands
+- The `docker run` command or `docker-compose.yml` used to start the image. Mask out the sensitive bits.
+- Please state if you are using [Boot2Docker](http://www.boot2docker.io), [VirtualBox](https://www.virtualbox.org), etc.
+
+# Getting started
+
+## Installation
+
+Automated builds of the image are available on [Dockerhub](https://hub.docker.com/r/dockage/alpine-openrc) and is the recommended method of installation.
+
+> **Note**: Builds are also available on [Quay.io](https://quay.io/repository/dockage/alpine-openrc)
+
+```bash
+docker pull dockage/alpine-openrc:0.24.1
+```
+
+Alternatively you can build the image yourself.
+
+```bash
+docker build -t dockage/alpine-openrc github.com/dockage/alpine-openrc
+```
+
+# Maintenance
+
+## Upgrading
+
+To upgrade to newer releases:
+
+  1. Download the updated Docker image:
+
+  ```bash
+  docker pull dockage/alpine-openrc:0.24.1
+  ```
+
+  2. Stop the currently running image:
+
+  ```bash
+  docker stop alpine-openrc
+  ```
+
+  3. Remove the stopped container
+
+  ```bash
+  docker rm -v alpine-openrc
+  ```
+
+  4. Start the updated image
+
+  ```bash
+  docker run --name alpine-openrc -itd \
+    [OPTIONS] \
+    dockage/alpine-openrc:0.24.1
+  ```
+
+## Shell Access
+
+For debugging and maintenance purposes you may want access the containers shell. If you are using Docker version `1.3.0` or higher you can access a running containers shell by starting `bash` using `docker exec`:
+
+```bash
+docker exec -it alpine-openrc sh