Skip to content

Commit 9268200

Browse files
committed
Updated documentation.
1 parent 11838bf commit 9268200

2 files changed

Lines changed: 33 additions & 23 deletions

File tree

DOCKERHUB.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,16 @@
77
[![Source](https://img.shields.io/badge/Source-GitHub-blue?logo=github&style=for-the-badge)](https://github.com/jlesage/docker-makemkv)
88
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg?style=for-the-badge)](https://paypal.me/JocelynLeSage)
99

10-
This is a Docker container for [MakeMKV](https://www.makemkv.com).
10+
This project provides a lightweight and secure Docker container for
11+
[MakeMKV](https://www.makemkv.com).
1112

12-
The graphical user interface (GUI) of the application can be accessed through a
13-
modern web browser, requiring no installation or configuration on the client
13+
Access the application's full graphical interface directly from any modern web
14+
browser - no downloads, installs, or setup required on the client side - or
15+
connect with any VNC client.
16+
17+
The web interface also offers audio playback, seamless clipboard sharing, an
18+
integrated file manager and terminal for accessing the container's files and
19+
shell, desktop notifications, and more.
1420

1521
A fully automated mode is also available: insert a DVD or Blu-ray disc into an
1622
optical drive and let MakeMKV rips it without any user interaction.

README.md

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,16 @@
66
[![Build Status](https://img.shields.io/github/actions/workflow/status/jlesage/docker-makemkv/build-image.yml?logo=github&branch=master&style=for-the-badge)](https://github.com/jlesage/docker-makemkv/actions/workflows/build-image.yml)
77
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg?style=for-the-badge)](https://paypal.me/JocelynLeSage)
88

9-
This project provides a Docker container for [MakeMKV](https://www.makemkv.com).
9+
This project provides a lightweight and secure Docker container for
10+
[MakeMKV](https://www.makemkv.com).
1011

11-
The graphical user interface (GUI) of the application can be accessed through a
12-
modern web browser, requiring no installation or configuration on the client
13-
side, or via any VNC client.
12+
Access the application's full graphical interface directly from any modern web
13+
browser - no downloads, installs, or setup required on the client side - or
14+
connect with any VNC client.
15+
16+
The web interface also offers audio playback, seamless clipboard sharing, an
17+
integrated file manager and terminal for accessing the container's files and
18+
shell, desktop notifications, and more.
1419

1520
A fully automated mode is also available: insert a DVD or Blu-ray disc into an
1621
optical drive and let MakeMKV rips it without any user interaction.
@@ -47,6 +52,7 @@ multiple video/audio tracks with all meta-information and preserve chapters.
4752
* [Synology](#synology)
4853
* [unRAID](#unraid)
4954
* [User/Group IDs](#usergroup-ids)
55+
* [Shell Access](#shell-access)
5056
* [Accessing the GUI](#accessing-the-gui)
5157
* [Security](#security)
5258
* [SSVNC](#ssvnc)
@@ -62,9 +68,8 @@ multiple video/audio tracks with all meta-information and preserve chapters.
6268
* [Web Audio](#web-audio)
6369
* [Web File Manager](#web-file-manager)
6470
* [Web Notifications](#web-notifications)
65-
* [Web Terminal](#web-terminal)
71+
* [Web Terminal](#web-terminal)
6672
* [GPU Acceleration Support](#gpu-acceleration-support)
67-
* [Shell Access](#shell-access)
6873
* [Access to Optical Drives](#access-to-optical-drives)
6974
* [Automatic Disc Ripper](#automatic-disc-ripper)
7075
* [Hooks](#hooks)
@@ -271,7 +276,6 @@ Adjust the configuration to suit your needs. Only mandatory settings are
271276
included in this example.
272277
273278
```yaml
274-
version: '3'
275279
services:
276280
makemkv:
277281
image: jlesage/makemkv
@@ -393,6 +397,17 @@ uid=1000(myuser) gid=1000(myuser) groups=1000(myuser),4(adm),24(cdrom),27(sudo),
393397
394398
Use the `uid` (user ID) and `gid` (group ID) values to configure the container.
395399
400+
## Shell Access
401+
402+
To access the shell of a running container, execute the following command:
403+
404+
```shell
405+
docker exec -ti CONTAINER sh
406+
```
407+
408+
Where `CONTAINER` is the ID or the name of the container used during its
409+
creation.
410+
396411
## Accessing the GUI
397412
398413
Assuming the container's ports are mapped to the same host's ports, access the
@@ -653,7 +668,7 @@ window to open it.
653668
| **Keyboard** icon | Toggle the on-screen keyboard. Visible only on touch devices. |
654669
| **Fullscreen** icon | Toggle fullscreen mode for the browser window. |
655670
| **Hand** icon| Allows dragging/moving the application window. Visible only when **Scaling Mode** is *None* and **Clip to Window** is enabled.
656-
| **Folder** icon | Opens the intgegrated file browser. Visible only when the [file manager](#web-file-manager) is enabled. |
671+
| **Folder** icon | Opens the integrated file browser. Visible only when the [file manager](#web-file-manager) is enabled. |
657672
| **Terminal** icon | Opens the integrated terminal. Visibile only when the [terminal](#web-terminal) is enabled. |
658673
| **Clipboard** text box| Mirrors the application’s clipboard. Any text typed or pasted here is sent to the application, and text copied inside the application automatically appears here. Hidden when [automatic clipboard synchronization](#automatic-clipboard-sync) is active. |
659674
| **Clear** button | Clears the clipboard. Hidden when [automatic clipboard synchronization](#automatic-clipboard-sync) is active. |
@@ -763,7 +778,7 @@ configuring environment variables.
763778
> [!NOTE]
764779
> This feature is not available to VNC clients.
765780
766-
### Web Terminal
781+
## Web Terminal
767782
768783
The container includes a web-based terminal, allowing users to easily obtain
769784
shell access to the running container through a web browser.
@@ -801,17 +816,6 @@ drivers installed, and the GPU device `/dev/dri` must be exposed to the
801816
container. For example, this is done by adding the `--device /dev/dri`
802817
argument to the `docker run` command.
803818
804-
## Shell Access
805-
806-
To access the shell of a running container, execute the following command:
807-
808-
```shell
809-
docker exec -ti CONTAINER sh
810-
```
811-
812-
Where `CONTAINER` is the ID or the name of the container used during its
813-
creation.
814-
815819
## Access to Optical Drives
816820
817821
By default, a Docker container does not have access to host's devices. However,

0 commit comments

Comments
 (0)