Skip to content

Commit 1253f1e

Browse files
Run update.sh
1 parent fc1ae7a commit 1253f1e

File tree

2 files changed

+50
-24
lines changed

2 files changed

+50
-24
lines changed

arangodb/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ WARNING:
2424

2525
# Supported tags and respective `Dockerfile` links
2626

27-
- [`3.12`, `3.12.5`, `latest`](https://github.com/arangodb/arangodb-docker/blob/fc9ce3eff9804b5232c97894c603266eae12a592/alpine/3.12.5/Dockerfile)
27+
- [`3.12`, `3.12.5.2`, `latest`](https://github.com/arangodb/arangodb-docker/blob/0584d0d3a17f0d4b13cd549b0f4f36a1f6cc65cc/alpine/3.12.5.2/Dockerfile)
2828

2929
# Quick reference (cont.)
3030

yourls/README.md

Lines changed: 49 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ WARNING:
1717
# Quick reference
1818

1919
- **Maintained by**:
20-
[YOURLS](https://github.com/YOURLS/docker)
20+
[YOURLS](https://github.com/YOURLS/containers)
2121

2222
- **Where to get help**:
2323
[the Docker Community Slack](https://dockr.ly/comm-slack), [Server Fault](https://serverfault.com/help/on-topic), [Unix & Linux](https://unix.stackexchange.com/help/on-topic), or [Stack Overflow](https://stackoverflow.com/help/on-topic)
@@ -33,7 +33,7 @@ WARNING:
3333
# Quick reference (cont.)
3434

3535
- **Where to file issues**:
36-
[https://github.com/YOURLS/docker/issues](https://github.com/YOURLS/docker/issues?q=)
36+
[https://github.com/YOURLS/containers/issues](https://github.com/YOURLS/containers/issues?q=)
3737

3838
- **Supported architectures**: ([more info](https://github.com/docker-library/official-images#architectures-other-than-amd64))
3939
[`amd64`](https://hub.docker.com/r/amd64/yourls/), [`arm32v5`](https://hub.docker.com/r/arm32v5/yourls/), [`arm32v6`](https://hub.docker.com/r/arm32v6/yourls/), [`arm32v7`](https://hub.docker.com/r/arm32v7/yourls/), [`arm64v8`](https://hub.docker.com/r/arm64v8/yourls/), [`i386`](https://hub.docker.com/r/i386/yourls/), [`mips64le`](https://hub.docker.com/r/mips64le/yourls/), [`ppc64le`](https://hub.docker.com/r/ppc64le/yourls/), [`riscv64`](https://hub.docker.com/r/riscv64/yourls/), [`s390x`](https://hub.docker.com/r/s390x/yourls/)
@@ -61,29 +61,42 @@ YOURLS is a set of PHP scripts that will allow you to run Your Own URL Shortener
6161

6262
## Start a `yourls` server instance
6363

64-
```console
65-
$ docker run --name some-yourls --link some-mysql:mysql \
66-
-e YOURLS_SITE="https://example.com" \
67-
-e YOURLS_USER="example_username" \
68-
-e YOURLS_PASS="example_password" \
69-
-d yourls
64+
```bash
65+
docker run \
66+
--name some-yourls \
67+
--detach \
68+
--network some-network \
69+
--env YOURLS_SITE="https://example.com" \
70+
--env YOURLS_USER="example_username" \
71+
--env YOURLS_PASS="example_password" \
72+
yourls
7073
```
7174

7275
The YOURLS instance accepts a number of environment variables for configuration, see *Environment Variables* section below.
7376

74-
If you'd like to use an external database instead of a linked `mysql` container, specify the hostname and port with `YOURLS_DB_HOST` along with the password in `YOURLS_DB_PASS` and the username in `YOURLS_DB_USER` (if it is something other than `root`):
77+
If you'd like to use an external database instead of a `mysql` container, specify the hostname and port with `YOURLS_DB_HOST` along with the password in `YOURLS_DB_PASS` and the username in `YOURLS_DB_USER` (if it is something other than `root`):
7578

76-
```console
77-
$ docker run --name some-yourlss -e YOURLS_DB_HOST=10.1.2.3:3306 \
78-
-e YOURLS_DB_USER=... -e YOURLS_DB_PASS=... -d yourls
79+
```bash
80+
docker run \
81+
--name some-yourls \
82+
--detach \
83+
--env YOURLS_DB_HOST=... \
84+
--env YOURLS_DB_USER=... \
85+
--env YOURLS_DB_PASS=... \
86+
yourls
7987
```
8088

8189
## Connect to the YOURLS administration interface
8290

8391
If you'd like to be able to access the instance from the host without the container's IP, standard port mappings can be used:
8492

85-
```console
86-
$ docker run --name some-yourls --link some-mysql:mysql -p 8080:80 -d yourls
93+
```bash
94+
docker run \
95+
--name some-yourls \
96+
--detach \
97+
--network some-network \
98+
--publish 8080:8080 \
99+
yourls
87100
```
88101

89102
Then, access it via `http://localhost:8080/admin/` or `http://<host-ip>:8080/admin/` in a browser.
@@ -92,7 +105,7 @@ Then, access it via `http://localhost:8080/admin/` or `http://<host-ip>:8080/adm
92105

93106
## Environment Variables
94107

95-
When you start the `yourls` image, you can adjust the configuration of the YOURLS instance by passing one or more environment variables on the `docker run` command line.
108+
When you start the `yourls` image, you can adjust the configuration of the YOURLS instance by passing one or more environment variables on the `docker run` command-line.
96109
The YOURLS instance accepts [a number of environment variables for configuration](https://yourls.org/docs/guide/essentials/configuration).
97110
A few notable/important examples for using this Docker image include the following.
98111

@@ -137,8 +150,12 @@ Database tables prefix, defaults to `yourls_`. Only set this when you need to ov
137150

138151
As an alternative to passing sensitive information via environment variables, `_FILE` may be appended to the previously listed environment variables, causing the initialization script to load the values for those variables from files present in the container. In particular, this can be used to load passwords from Docker secrets stored in `/run/secrets/<secret_name>` files. For example:
139152

140-
```console
141-
$ docker run --name some-yourls -e YOURLS_DB_PASS_FILE=/run/secrets/mysql-root ... -d yourls:tag
153+
```bash
154+
docker run \
155+
--name some-yourls \
156+
--detach \
157+
--env YOURLS_DB_PASS_FILE=/run/secrets/mysql-root \
158+
yourls
142159
```
143160

144161
Currently, this is supported for `YOURLS_DB_HOST`, `YOURLS_DB_USER`, `YOURLS_DB_PASS`, `YOURLS_DB_NAME`, `YOURLS_DB_PREFIX`, `YOURLS_SITE`, `YOURLS_USER`, and `YOURLS_PASS`.
@@ -148,38 +165,47 @@ Currently, this is supported for `YOURLS_DB_HOST`, `YOURLS_DB_USER`, `YOURLS_DB_
148165
Example `compose.yaml` for `yourls`:
149166

150167
```yaml
168+
name: yourls
151169
services:
152-
153170
yourls:
154171
image: yourls
155172
restart: always
173+
depends_on:
174+
- mysql
156175
ports:
157-
- 8080:80
176+
- 8080:8080
158177
environment:
159178
YOURLS_DB_PASS: example
160179
YOURLS_SITE: https://example.com
161180
YOURLS_USER: example_username
162181
YOURLS_PASS: example_password
163-
164182
mysql:
165183
image: mysql
166184
restart: always
167185
environment:
168186
MYSQL_ROOT_PASSWORD: example
169187
MYSQL_DATABASE: yourls
188+
volumes:
189+
- db:/var/lib/mysql
170190
```
171191
172-
Run `docker compose up`, wait for it to initialize completely, and visit `http://localhost:8080/admin/` or `http://<host-ip>:8080/admin/` (as appropriate).
192+
Run `docker compose up`, wait for it to initialize completely, and visit `http://localhost:8080/admin/`, or `http://<host-ip>:8080/admin/` (as appropriate).
173193

174194
## Adding additional libraries / extensions
175195

176196
This image does not provide any additional PHP extensions or other libraries, even if they are required by popular plugins. There are an infinite number of possible plugins, and they potentially require any extension PHP supports. Including every PHP extension that exists would dramatically increase the image size.
177197

178198
If you need additional PHP extensions, you'll need to create your own image `FROM` this one. The [documentation of the `php` image](https://github.com/docker-library/docs/blob/master/php/README.md#how-to-install-more-php-extensions) explains how to compile additional extensions.
179199

180-
The following Docker Hub features can help with the task of keeping your dependent images up-to-date:
200+
## Include persistent user-content
201+
202+
Mount the volume containing your plugins, pages or languages to the proper directory; and then apply them through the "admin" UI. Ensure read/write/execute permissions are in place for the user:
203+
204+
- Plugins go in a subdirectory in `/var/www/html/user/plugins/`
205+
- Pages go in a subdirectory in `/var/www/html/user/pages/`
206+
- Languages go in a subdirectory in `/var/www/html/user/languages/`
181207

182-
- [Automated Builds](https://docs.docker.com/docker-hub/builds/) let Docker Hub automatically build your Dockerfile each time you push changes to it.
208+
If you wish to provide additional content in an image for deploying in multiple installations, place it in the same directories under `/usr/src/yourls/` instead (which gets copied to `/var/www/html/` on the container's initial startup).
183209

184210
# Image Variants
185211

0 commit comments

Comments
 (0)