You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: webpage/docs/installation/docker-images.md
+69-42
Original file line number
Diff line number
Diff line change
@@ -12,24 +12,53 @@ The base image is available as multi-arch image at [`ghcr.io/m1k1o/neko/base`](h
12
12
13
13
## Naming Convention {#naming}
14
14
15
-
Neko Docker images are available on [GitHub Container Registry (GHCR)](https://github.com/m1k1o?tab=packages&repo_name=neko). The naming convention for Neko Docker images is as follows:
15
+
Neko images are available on two public registries. The [GitHub Container Registry (GHCR)](#ghcr.io) hosts stable releases with all flavors and architectures. The latest development version of the Neko image for the AMD64 architecture is available on [Docker Hub](#docker.io).
16
+
17
+
:::info
18
+
You should always prefer the GHCR registry, as it supports flavors and specific versions, unless you want to test the latest development version.
19
+
:::
20
+
21
+
### GitHub Container Registry (GHCR) {#ghcr.io}
22
+
23
+
Neko Docker images are available on the [GitHub Container Registry (GHCR)](https://github.com/m1k1o?tab=packages&repo_name=neko). The naming convention for Neko Docker images is as follows:
-`<flavor>` is the optional flavor of the image, see [Available Flavors](#flavors) for more information.
22
-
-`<application>` is the application name or base image, see [Available Applications](#apps) for more information.
23
-
-`<version>` is the [semantic version](https://semver.org/) of the image from the [GitHub tags](https://github.com/m1k1o/neko/tags). There is always a `latest` tag available.
29
+
-`<flavor>` is the optional flavor of the image. See [Available Flavors](#flavors) for more information.
30
+
-`<application>` is the application name or base image. See [Available Applications](#apps) for more information.
31
+
-`<version>` is the version of the image. See [Versioning](#ghcr.io-versioning) for more information.
32
+
33
+
#### Versioning scheme {#ghcr.io-versioning}
34
+
35
+
The versioning scheme follows the [Semantic Versioning 2.0.0](https://semver.org/) specification. The following tags are available for each image:
36
+
37
+
-`latest` - Points to the most recent stable release.
38
+
-`MAJOR` - Tracks the latest release within the specified major version.
39
+
-`MAJOR.MINOR` - Tracks the latest release within the specified major and minor version.
40
+
-`MAJOR.MINOR.PATCH` - Refers to a specific release.
-`ghcr.io/m1k1o/neko/firefox:3` - Latest release in the 3.x.x series.
45
+
-`ghcr.io/m1k1o/neko/firefox:3.0` - Latest release in the 3.0.x series.
46
+
-`ghcr.io/m1k1o/neko/firefox:3.0.0` - Specific version 3.0.0.
47
+
48
+
A full list of published versions can be found in the [GitHub tags](https://github.com/m1k1o/neko/tags).
49
+
50
+
### Docker Hub {#docker.io}
24
51
25
-
An alternative registry is also available on [Docker Hub](https://hub.docker.com/r/m1k1o/neko), however, only images without flavor and with the latest version are available there.
52
+
An alternative registry is available on [Docker Hub](https://hub.docker.com/r/m1k1o/neko). This registry hosts images built from the latest code in the [master branch](https://github.com/m1k1o/neko/tree/master). However, it only includes images without flavors and supports the AMD64 architecture. The naming convention for these images is as follows:
26
53
27
54
```
28
55
m1k1o/neko:<application>
29
56
```
30
57
58
+
-`<application>` is the application name or base image. See [Available Applications](#apps) for more information.
59
+
31
60
:::info
32
-
You should always prefer the GHCR registry with the ability to use flavors and specific versions.
61
+
`m1k1o/neko:latest` is an alias for `m1k1o/neko:firefox` due to historical reasons. It is recommended to use the `ghcr.io/m1k1o/neko/firefox:latest` image instead.
33
62
:::
34
63
35
64
## Available Applications {#apps}
@@ -162,42 +191,6 @@ docker run \
162
191
See [neko-apps](https://github.com/m1k1o/neko-apps) repository for more applications.
163
192
:::
164
193
165
-
166
-
## Supported Architectures {#arch}
167
-
168
-
Neko Docker images are built with docker buildx and are available for multiple architectures. The following architectures are supported by the base image:
-`linux/arm64` - 64-bit ARM architecture (e.g., Raspberry Pi 4, Apple M1/M2).
172
-
-`linux/arm/v7` - 32-bit ARM architecture (e.g., Raspberry Pi 3, Raspberry Pi Zero).
173
-
174
-
### Availability Matrix {#availability}
175
-
176
-
The availability of applications for ARM architecture is limited due to the lack of support for some applications. The following table shows the availability of each application for each architecture. The `✅` symbol indicates that the application is available for that architecture, while the `❌` symbol indicates that it is not available.
[Oracle Cloud ARM free tier](https://www.oracle.com/cloud/free/) is a great way to test Neko on ARM architecture for free. You can use the `ghcr.io/m1k1o/neko/xfce` image to run a full desktop environment with Xfce and test the applications.
199
-
:::
200
-
201
194
## Available Flavors {#flavors}
202
195
203
196
:::danger Keep in Mind
@@ -250,3 +243,37 @@ The base image is available at [`ghcr.io/m1k1o/neko/nvidia-base`](https://ghcr.i
250
243
There is a known issue with EGL and Chromium-based browsers, see [m1k1o/neko #279](https://github.com/m1k1o/neko/issues/279).
251
244
:::
252
245
246
+
## Supported Architectures {#arch}
247
+
248
+
Neko Docker images are built with docker buildx and are available for multiple architectures. The following architectures are supported by the base image:
-`linux/arm64` - 64-bit ARM architecture (e.g., Raspberry Pi 4, Apple M1/M2).
252
+
-`linux/arm/v7` - 32-bit ARM architecture (e.g., Raspberry Pi 3, Raspberry Pi Zero).
253
+
254
+
### Availability Matrix {#availability}
255
+
256
+
The availability of applications for ARM architecture is limited due to the lack of support for some applications. The following table shows the availability of each application for each architecture. The `✅` symbol indicates that the application is available for that architecture, while the `❌` symbol indicates that it is not available.
[Oracle Cloud ARM free tier](https://www.oracle.com/cloud/free/) is a great way to test Neko on ARM architecture for free. You can use the `ghcr.io/m1k1o/neko/xfce` image to run a full desktop environment with Xfce and test the applications.
0 commit comments