Skip to content

Commit

Permalink
docs: update all readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
alimd committed Nov 24, 2023
1 parent 81d843a commit 0f9ef61
Show file tree
Hide file tree
Showing 12 changed files with 178 additions and 4 deletions.
4 changes: 2 additions & 2 deletions adminer/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ ARG BUILD_DATE
LABEL org.opencontainers.image.title="alwatr/adminer" \
org.opencontainers.image.description="Database management in a single PHP file, packaged by Alwatr." \
org.opencontainers.image.base.name="docker.io/library/adminer:4.8-3.24.4" \
org.opencontainers.image.version="4.8" \
org.opencontainers.image.version="4.8.1" \
org.opencontainers.image.ref.name="4.8-3.24.4" \
org.opencontainers.image.licenses="MIT" \
org.opencontainers.image.created=${BUILD_DATE} \
Expand All @@ -15,5 +15,5 @@ LABEL org.opencontainers.image.title="alwatr/adminer" \
org.opencontainers.image.url="https://github.com/Alwatr/containers/tree/next/adminer" \
org.opencontainers.image.documentation="https://github.com/Alwatr/containers/tree/next/adminer" \
org.opencontainers.image.authors="S. Ali Mihandoost <[email protected]> (https://ali.mihandoost.com), S. Amir Mohammad Najafi <[email protected]> (https://njfamirm.ir/)" \
cloud.alwatr.image.version.full="4.8-3.24.4" \
cloud.alwatr.image.version.full="4.8.1" \
cloud.alwatr.image.version.short="4"
16 changes: 16 additions & 0 deletions adminer/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
# Alwatr Adminer Container

Database management in a single PHP file, packaged by Alwatr.

## Usage

Check versions from [Alwatr/packages](https://github.com/Alwatr/containers/pkgs/container/adminer)

### Install from the command line

```bash
docker pull ghcr.io/alwatr/adminer:4.8.1
```

### Use as base image in Dockerfile

```dockerfile
FROM ghcr.io/alwatr/adminer:4.8.1
```
16 changes: 15 additions & 1 deletion alpine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,23 @@ This took **28s** to build and yields a **169MB** image!
### Start doing this

```dockerfile
FROM alpine:3.16
FROM ghcr.io/alwatr/alpine:3.18.4
RUN apk add --no-cache mysql-client
ENTRYPOINT ["mysql"]
```

Only **4s** to build and results in a **41MB** image!

Check versions from [Alwatr/packages](https://github.com/Alwatr/containers/pkgs/container/alpine)

### Install from the command line

```bash
docker pull ghcr.io/alwatr/alpine:3.18.4
```

### Use as base image in Dockerfile

```dockerfile
FROM pull ghcr.io/alwatr/alpine:3.18.4
```
16 changes: 16 additions & 0 deletions mariadb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,22 @@

MariaDB was designed as a drop-in replacement of MySQL(R) with more features, new storage engines, fewer bugs, and better performance, packaged by Alwatr.

## Usage

Check versions from [Alwatr/packages](https://github.com/Alwatr/containers/pkgs/container/mariadb)

### Install from the command line

```bash
docker pull ghcr.io/alwatr/mariadb:11.1.3
```

### Use as base image in Dockerfile

```dockerfile
FROM ghcr.io/alwatr/mariadb:11.1.3
```

## Environment Variables

| Variable | v11.x | v10.x |
Expand Down
16 changes: 16 additions & 0 deletions nocodb/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
# Alwatr Nocodb Container

A free, open-source, self-hosted, and extensible database management tool that helps you easily manage and visualize your data, packaged by Alwatr.

## Usage

Check versions from [Alwatr/packages](https://github.com/Alwatr/containers/pkgs/container/nocodb)

### Install from the command line

```bash
docker pull ghcr.io/alwatr/nocodb:0.202.8
```

### Use as base image in Dockerfile

```dockerfile
FROM ghcr.io/alwatr/nocodb:0.202.8
```
18 changes: 17 additions & 1 deletion node/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
# Alwatr Node.js Container

Cross-platform ECMAScript runtime environment, packaged by Alwatr.
Cross-platform ECMAScript runtime environment, packaged by Alwatr.

## Usage

Check versions from [Alwatr/packages](https://github.com/Alwatr/containers/pkgs/container/node)

### Install from the command line

```bash
docker pull ghcr.io/alwatr/node:20.10.0
```

### Use as base image in Dockerfile

```dockerfile
FROM ghcr.io/alwatr/node:20.10.0
```
16 changes: 16 additions & 0 deletions opencv/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
# Alwatr OpenCV Container

Native OpenCV library in Node.js, packaged by Alwatr.

## Usage

Check versions from [Alwatr/packages](https://github.com/Alwatr/containers/pkgs/container/opencv)

### Install from the command line

```bash
docker pull ghcr.io/alwatr/opencv:4.8.1
```

### Use as base image in Dockerfile

```dockerfile
FROM ghcr.io/alwatr/opencv:4.8.1
```
16 changes: 16 additions & 0 deletions php/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
# Alwatr PHP Container

A very slow, lazy and stupid server-side programming language for newbies, packaged by Alwatr.

## Usage

Check versions from [Alwatr/packages](https://github.com/Alwatr/containers/pkgs/container/php)

### Install from the command line

```bash
docker pull ghcr.io/alwatr/php:8.2.12
```

### Use as base image in Dockerfile

```dockerfile
FROM ghcr.io/alwatr/php:8.2.12
```
16 changes: 16 additions & 0 deletions postgres/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,22 @@

Alpine-based PostgreSQL container image with orchestrations, packaged by Alwatr.

## Usage

Check versions from [Alwatr/packages](https://github.com/Alwatr/containers/pkgs/container/postgres)

### Install from the command line

```bash
docker pull ghcr.io/alwatr/postgres:16.1
```

### Use as base image in Dockerfile

```dockerfile
FROM ghcr.io/alwatr/postgres:16.1
```

## Environment Variables

| Variable | Default Value | Description |
Expand Down
16 changes: 16 additions & 0 deletions tdlib/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
# Alwatr Telegram Database Library Container

A library to access Telegram database, written in C++ and cross-platform, packaged by Alwatr.

## Usage

Check versions from [Alwatr/packages](https://github.com/Alwatr/containers/pkgs/container/tdlib)

### Install from the command line

```bash
docker pull ghcr.io/alwatr/tdlib:1.8.0
```

### Use as base image in Dockerfile

```dockerfile
FROM ghcr.io/alwatr/tdlib:1.8.0
```
16 changes: 16 additions & 0 deletions traefik/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,19 @@
Traefik is designed to work with modern container orchestration platforms like Docker and Kubernetes, and it can automatically discover new services as they are added to the environment. It also provides advanced features like automatic SSL certificate generation and renewal, dynamic routing based on service health checks, and support for multiple backends.

For more information on Traefik, see the official documentation at <https://doc.traefik.io/traefik/>.

## Usage

Check versions from [Alwatr/packages](https://github.com/Alwatr/containers/pkgs/container/traefik)

### Install from the command line

```bash
docker pull ghcr.io/alwatr/traefik:3.0.0-beta4
```

### Use as base image in Dockerfile

```dockerfile
FROM ghcr.io/alwatr/traefik:3.0.0-beta4
```
16 changes: 16 additions & 0 deletions wordpress/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
# Alwatr Wordpress Container

A very slow, lazy and stupid CMS for newbies, packaged by Alwatr.

## Usage

Check versions from [Alwatr/packages](https://github.com/Alwatr/containers/pkgs/container/wordpress)

### Install from the command line

```bash
docker pull ghcr.io/alwatr/wordpress:6.4.1
```

### Use as base image in Dockerfile

```dockerfile
FROM ghcr.io/alwatr/wordpress:6.4.1
```

0 comments on commit 0f9ef61

Please sign in to comment.