9.2 KiB
title |
---|
fleet |
linuxserver/fleet
Fleet provides an online web interface which displays a set of maintained images from one or more owned repositories.
Supported Architectures
Our images support multiple architectures such as x86-64
, arm64
and armhf
. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling ghcr.io/linuxserver/fleet
should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
Architecture | Tag |
---|---|
x86-64 | amd64-latest |
arm64 | arm64v8-latest |
armhf | arm32v7-latest |
Application Setup
Navigate to http://your_ip_here:8080
to display the home page. If DATABASE
is selected as the preferred authentication process, ensure that you set up an
initial user via http://your_ip_here:8080/setup
. Once done, that page will no longer be available. A restart is preferable as it will remove the page altogether.
Once complete, you can log into the app via http://your_ip_here:8080/login
to manage your repositories.
Usage
Here are some example snippets to help you get started creating a container from this image.
docker-compose (recommended)
Compatible with docker-compose v2 schemas.
---
version: "2.1"
services:
fleet:
image: ghcr.io/linuxserver/fleet
container_name: fleet
environment:
- PUID=1000
- PGID=1000
- fleet_admin_authentication_type=DATABASE
- fleet_database_url=jdbc:mariadb://<url>:3306/fleet
- fleet_database_username=fleet_user
- fleet_database_password=dbuserpassword
- fleet_admin_secret=randomstring #optional
volumes:
- </path/to/appdata/config>:/config
ports:
- 8080:8080
restart: unless-stopped
docker cli
docker run -d \
--name=fleet \
-e PUID=1000 \
-e PGID=1000 \
-e fleet_admin_authentication_type=DATABASE \
-e fleet_database_url=jdbc:mariadb://<url>:3306/fleet \
-e fleet_database_username=fleet_user \
-e fleet_database_password=dbuserpassword \
-e fleet_admin_secret=randomstring `#optional` \
-p 8080:8080 \
-v </path/to/appdata/config>:/config \
--restart unless-stopped \
ghcr.io/linuxserver/fleet
Parameters
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal>
respectively. For example, -p 8080:80
would expose port 80
from inside the container to be accessible from the host's IP on port 8080
outside the container.
Ports (-p
)
Parameter | Function |
---|---|
8080 |
Http port |
Environment Variables (-e
)
Env | Function |
---|---|
PUID=1000 |
for UserID - see below for explanation |
PGID=1000 |
for GroupID - see below for explanation |
fleet_admin_authentication_type=DATABASE |
A switch to define how Fleet manages user logins. If set to DATABASE, see the related optional params. Can be set to either DATABASE or PROPERTIES. |
fleet_database_url=jdbc:mariadb://<url>:3306/fleet |
The full JDBC connection string to the Fleet database |
fleet_database_username=fleet_user |
The username with the relevant GRANT permissions for the database |
fleet_database_password=dbuserpassword |
The database user's password. |
fleet_admin_secret=randomstring |
A string used as part of the password key derivation process. |
Volume Mappings (-v
)
Volume | Function |
---|---|
/config |
The primary config file and rolling log files. |
Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend FILE__
.
As an example:
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Will set the environment variable PASSWORD
based on the contents of the /run/secrets/mysecretpassword
file.
Umask for running applications
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022
setting.
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.
User / Group Identifiers
When using volumes (-v
flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID
and group PGID
.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000
and PGID=1000
, to find yours use id user
as below:
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Docker Mods
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
Support Info
- Shell access whilst the container is running:
docker exec -it fleet /bin/bash
- To monitor the logs of the container in realtime:
docker logs -f fleet
- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' fleet
- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/fleet
Versions
- 26.04.20: - Updated to keep in line with v2.0.0 branch of Fleet
- 19.12.19: - Rebasing to alpine 3.11.
- 02.07.19: - Rebasing to alpine 3.10.
- 02.07.19: - Stop container if fleet fails.
- 19.05.19: - Use new base images for arm versions.
- 01.04.19: - Initial Release