kopia lustrzana https://github.com/linuxserver/docker-documentation
228 wiersze
12 KiB
Markdown
Executable File
228 wiersze
12 KiB
Markdown
Executable File
---
|
|
title: kdenlive
|
|
---
|
|
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
|
<!-- Please read the https://github.com/linuxserver/docker-kdenlive/blob/master/.github/CONTRIBUTING.md -->
|
|
|
|
# [linuxserver/kdenlive](https://github.com/linuxserver/docker-kdenlive)
|
|
|
|
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fkdenlive)
|
|
[](https://github.com/linuxserver/docker-kdenlive)
|
|
[](https://github.com/linuxserver/docker-kdenlive/releases)
|
|
[](https://github.com/linuxserver/docker-kdenlive/packages)
|
|
[](https://gitlab.com/linuxserver.io/docker-kdenlive/container_registry)
|
|
[](https://quay.io/repository/linuxserver.io/kdenlive)
|
|
[](https://hub.docker.com/r/linuxserver/kdenlive)
|
|
[](https://hub.docker.com/r/linuxserver/kdenlive)
|
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-kdenlive/job/master/)
|
|
[](https://ci-tests.linuxserver.io/linuxserver/kdenlive/latest/index.html)
|
|
|
|
[Kdenlive](https://kdenlive.org/) is a powerful free and open source cross-platform video editing program made by the KDE community. Feature rich and production ready.
|
|
|
|
## Supported Architectures
|
|
|
|
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
|
|
|
Simply pulling `lscr.io/linuxserver/kdenlive:latest` 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 | Available | Tag |
|
|
| :----: | :----: | ---- |
|
|
| x86-64 | ✅ | amd64-\<version tag\> |
|
|
| arm64 | ✅ | arm64v8-\<version tag\> |
|
|
| armhf| ✅ | arm32v7-\<version tag\> |
|
|
|
|
## Application Setup
|
|
|
|
The application can be accessed at:
|
|
* http://yourhost:3000/
|
|
|
|
By default the user/pass is abc/abc, if you change your password or want to login manually to the GUI session for any reason use the following link:
|
|
|
|
* http://yourhost:3000/?login=true
|
|
|
|
You can also force login on the '/' path without this parameter by passing the environment variable `-e AUTO_LOGIN=false`.
|
|
|
|
## Hardware Acceleration (x86_64 only)
|
|
|
|
In order to perform hardware transcoding you will need to mount a video device into the container. Some of the default hardware rendering/transcode profiles will point to devices in /dev/dri for `vaapi_device`. Make sure the profile you are using points to the correct device in the container. IE if you have intel integrated graphics along with an Nvdia or AMD video card you might have renderD128, renderD129, etc. To check which device is which use vainfo from inside the container: (right click the desktop and open xterm)
|
|
|
|
```
|
|
vainfo --display drm --device /dev/dri/renderD128
|
|
```
|
|
|
|
### Intel/ATI/AMD
|
|
|
|
To leverage hardware acceleration you will need to mount /dev/dri video device inside of the conainer.
|
|
```
|
|
--device=/dev/dri:/dev/dri
|
|
```
|
|
We will automatically ensure the abc user inside of the container has the proper permissions to access this device.
|
|
|
|
### Nvidia
|
|
|
|
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here:
|
|
https://github.com/NVIDIA/nvidia-docker
|
|
|
|
We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker is installed on your host you will need to re/create the docker container with the nvidia container runtime `--runtime=nvidia` and add an environment variable `-e NVIDIA_VISIBLE_DEVICES=all` (can also be set to a specific gpu's UUID, this can be discovered by running `nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv` ). NVIDIA automatically mounts the GPU and drivers from your host into the container.
|
|
|
|
#### Keyboard Layouts
|
|
|
|
This should match the layout on the computer you are accessing the container from.
|
|
The keyboard layouts available for use are:
|
|
* da-dk-qwerty- Danish keyboard
|
|
* de-ch-qwertz- Swiss German keyboard (qwertz)
|
|
* de-de-qwertz- German keyboard (qwertz) - **OSK available**
|
|
* en-gb-qwerty- English (UK) keyboard
|
|
* en-us-qwerty- English (US) keyboard - **OSK available** **DEFAULT**
|
|
* es-es-qwerty- Spanish keyboard - **OSK available**
|
|
* fr-ch-qwertz- Swiss French keyboard (qwertz)
|
|
* fr-fr-azerty- French keyboard (azerty) - **OSK available**
|
|
* it-it-qwerty- Italian keyboard - **OSK available**
|
|
* ja-jp-qwerty- Japanese keyboard
|
|
* pt-br-qwerty- Portuguese Brazilian keyboard
|
|
* sv-se-qwerty- Swedish keyboard
|
|
* tr-tr-qwerty- Turkish-Q keyboard
|
|
|
|
## Usage
|
|
|
|
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
|
|
|
|
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
|
|
|
|
```yaml
|
|
---
|
|
version: "2.1"
|
|
services:
|
|
kdenlive:
|
|
image: lscr.io/linuxserver/kdenlive:latest
|
|
container_name: kdenlive
|
|
security_opt:
|
|
- seccomp:unconfined #optional
|
|
environment:
|
|
- PUID=1000
|
|
- PGID=1000
|
|
- TZ=Europe/London
|
|
- SUBFOLDER=/ #optional
|
|
- KEYBOARD=en-us-qwerty #optional
|
|
volumes:
|
|
- /path/to/config:/config
|
|
ports:
|
|
- 3000:3000
|
|
devices:
|
|
- /dev/dri:/dev/dri #optional
|
|
shm_size: "1gb" #optional
|
|
restart: unless-stopped
|
|
```
|
|
|
|
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
|
|
|
|
```bash
|
|
docker run -d \
|
|
--name=kdenlive \
|
|
--security-opt seccomp=unconfined `#optional` \
|
|
-e PUID=1000 \
|
|
-e PGID=1000 \
|
|
-e TZ=Europe/London \
|
|
-e SUBFOLDER=/ `#optional` \
|
|
-e KEYBOARD=en-us-qwerty `#optional` \
|
|
-p 3000:3000 \
|
|
-v /path/to/config:/config \
|
|
--device /dev/dri:/dev/dri `#optional` \
|
|
--shm-size="1gb" `#optional` \
|
|
--restart unless-stopped \
|
|
lscr.io/linuxserver/kdenlive:latest
|
|
```
|
|
|
|
## 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 |
|
|
| :----: | --- |
|
|
| `3000` | Kdenlive desktop gui |
|
|
|
|
### Environment Variables (`-e`)
|
|
|
|
| Env | Function |
|
|
| :----: | --- |
|
|
| `PUID=1000` | for UserID - see below for explanation |
|
|
| `PGID=1000` | for GroupID - see below for explanation |
|
|
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
|
|
| `SUBFOLDER=/` | Specify a subfolder to use with reverse proxies, IE `/subfolder/` |
|
|
| `KEYBOARD=en-us-qwerty` | See the keyboard layouts section for more information and options. |
|
|
|
|
### Volume Mappings (`-v`)
|
|
|
|
| Volume | Function |
|
|
| :----: | --- |
|
|
| `/config` | Users home directory in the container, stores local files and settings |
|
|
|
|
### Device Mappings (`--device`)
|
|
|
|
| Parameter | Function |
|
|
| :-----: | --- |
|
|
| `/dev/dri` | Add this for hardware acceleration (Linux hosts only) |
|
|
|
|
#### Miscellaneous Options
|
|
|
|
| Parameter | Function |
|
|
| :-----: | --- |
|
|
| `--shm-size=` | This might be needed to prevent crashing |
|
|
| `--security-opt seccomp=unconfined` | For Docker Engine only, this may be required depending on your Docker and storage configuration. |
|
|
|
|
## Environment variables from files (Docker secrets)
|
|
|
|
You can set any environment variable from a file by using a special prepend `FILE__`.
|
|
|
|
As an example:
|
|
|
|
```bash
|
|
-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](https://en.wikipedia.org/wiki/Umask) 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:
|
|
|
|
```bash
|
|
$ id username
|
|
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
|
```
|
|
|
|
## Docker Mods
|
|
|
|
[](https://mods.linuxserver.io/?mod=kdenlive "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
|
|
|
We publish various [Docker Mods](https://github.com/linuxserver/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 kdenlive /bin/bash`
|
|
* To monitor the logs of the container in realtime:
|
|
* `docker logs -f kdenlive`
|
|
* Container version number
|
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' kdenlive`
|
|
* Image version number
|
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/kdenlive:latest`
|
|
|
|
## Versions
|
|
|
|
* **09.03.22:** - Update seccomp explanation.
|
|
* **07.03.22:** - Initial release.
|