Merge branch 'develop' into beta

rapejim · Dec 2, 2021 · 4d5814e · 4d5814e
2 parents 78585b7 + caf3654
commit 4d5814e
Show file tree

Hide file tree

Showing 2 changed files with 233 additions and 156 deletions.
diff --git a/README.ES.md b/README.ES.md
@@ -2,50 +2,39 @@
 
 <div align="center"><img src="https://raw.githubusercontent.com/rapejim/pms-plexdrive-docker/public/images/banner.png" width="50%"></div>
 
-Combina el poder de **Plex Media Server** *(en adelante PMS)* con
-los archivos multimedia en tu cuenta de Google Drive (o
-[Unidad Compartida](https://support.google.com/a/users/answer/9310156?hl=es))
-montados por [**Plexdrive**](https://github.com/plexdrive/plexdrive).
+Combina el poder de **Plex Media Server** *(en adelante PMS)* con los archivos multimedia de tu cuenta de Google Drive (o en una [Unidad Compartida](https://support.google.com/a/users/answer/9310156?hl=es)) montados con [**Plexdrive**](https://github.com/plexdrive/plexdrive).
 
-Este respositorio está basado en la
-[imagen Docker oficial de PMS](https://hub.docker.com/r/plexinc/pms-docker) e
-instalado sobre [Plexdrive v.5.1.0](https://github.com/plexdrive/plexdrive). <br/>
-*Bifurcado del repositorio original <https://bitbucket.org/sh1ny/docker-pms-plexdrive>.*
+Basado en la [imagen docker oficial de PMS](https://hub.docker.com/r/plexinc/pms-docker) e instalado dentro [Plexdrive v.5.1.0](https://github.com/plexdrive/plexdrive).
+Bifurcado del repositorio original <https://bitbucket.org/sh1ny/docker-pms-plexdrive>.
 
-***IMPORTANTE:*** También se heredan todas las opciones originales del contenedor oficial de PMS.
-[Consulta la documentación de PMS para obtener más información](https://github.com/plexinc/pms-docker).*
-
-Puedes leer este documento en otros idiomas:
-[English](https://github.com/rapejim/pms-plexdrive-docker/blob/develop/README.md),
-[Español](https://github.com/rapejim/pms-plexdrive-docker/blob/develop/README.ES.md)
+***IMPORTANTE:*** Se heredan todas las opciones de la imagen oficial de PMS. [Documentación de PMS para más información](https://github.com/plexinc/pms-docker).
+<br/><br/>Puedes leer este documento en otros idiomas: [English](https://github.com/rapejim/pms-plexdrive-docker/blob/develop/README.md), [Español](https://github.com/rapejim/pms-plexdrive-docker/blob/develop/README.ES.md)
 
 ## *Prerrequisitos*
 ---
 
-Debes tener tu propio identificador de client (`Client ID`) y secreto de cliente
-(`Client Secret`) para configurar Plexdrive. En caso no cuentes con ello, puedes
-seguir cualquier guía en Internet, por ejemplo:
+Debes tener tu propio identificador de cliente (`Client ID`) y secreto de cliente (`Client Secret`) para configurar Plexdrive. En caso no cuentes con ello, puedes seguir alguna guía que encuentres por Internet, por ejemplo:
 
 - [Español](https://www.uint16.es/2019/11/04/como-obtener-tu-propio-client-id-de-google-drive-para-rclone/)
 - [English](https://github.com/Cloudbox/Cloudbox/wiki/Google-Drive-API-Client-ID-and-Client-Secret)
 
-También puedes usar los archivos `config.json` y` token.json` de una instalación
-previa de Plexdrive, aunque en este caso es preferible no reutilizar el archivo
-`cache.bolt` para que se genere uno nuevo.
+O puedes usar los archivos `config.json` y ` token.json` de una instalación previa de Plexdrive, aunque en este caso es preferible no reutilizar el archivo `cache.bolt` para que se genere uno nuevo.
+<br/><br/>
 
 ## *Ejemplos de comandos de ejecución*
 ---
 
-###  Ejemplo *básico* de ejecución del comando *(usando la red del host)*:
+##### Línea de comandos con red host
 
 ```bash
-docker run --name Plex -d \
+docker run --name plex -d \
     --net=host \
     -e TZ="Europe/Madrid" \
     -e PLEX_UID=${UID} \
     -e PLEX_GID=$(id -g) \
-    -v /docker/pms-plexdrive/config:/config \
-    -v /docker/pms-plexdrive/transcode:/transcode \
+    # -e PLEX_CLAIM: XXXXXXXXXXXXXXXXXXXXXXXXXX # Optional -> https://www.plex.tv/claim/
+    -v /docker/plex/config:/config \
+    -v /docker/plex/transcode:/transcode \ # Optional
     --privileged \
     --cap-add MKNOD \
     --cap-add SYS_ADMIN \
@@ -54,33 +43,25 @@ docker run --name Plex -d \
     rapejim/pms-plexdrive-docker
 ```
 
-***NOTA:*** *Debes reemplazar `Europe/Madrid` por tu zona horaria y las rutas
-de los volúmenes `/docker/pms-plexdrive/...` por la que tienes en tu ordenador
-(en caso no uses la misma estructura de carpetas). Si tienes los archivos de
-configuración (`config.json` y ` token.json`) de una instalación anterior de
-Plexdrive, colocalos en la carpeta `docker/pms-plexdrive/config/.plexdrive`.*
-<br/>
-<br/>
-<br/>
-
-### Ejemplo *Avanzado* de ejecución del comando *(usando la red tipo puente)*:
+##### Línea de comandos con red bridge
 
 ```bash
-docker run --name Plex -h Plex -d \
+docker run --name plex -h Plex -d \
     -p 32400:32400/tcp \
-    -p 3005:3005/tcp \ # Opcional
-    -p 8324:8324/tcp \ # Opcional
-    -p 32469:32469/tcp \ # Opcional
-    -p 1900:1900/udp \ # Opcional
-    -p 32410:32410/udp \ # Opcional
-    -p 32412:32412/udp \ # Opcional
-    -p 32413:32413/udp \ # Opcional
-    -p 32414:32414/udp \ # Opcional
+    # -p 1900:1900/udp \ # Optional
+    # -p 3005:3005/tcp \ # Optional
+    # -p 8324:8324/tcp \ # Optional
+    # -p 32410:32410/udp \ # Optional
+    # -p 32412:32412/udp \ # Optional
+    # -p 32413:32413/udp \ # Optional
+    # -p 32414:32414/udp \ # Optional
+    # -p 32469:32469/tcp \ # Optional
     -e TZ="Europe/Madrid" \
     -e PLEX_UID=${UID} \
     -e PLEX_GID=$(id -g) \
-    -v /docker/pms-plexdrive/config:/config \
-    -v /docker/pms-plexdrive/transcode:/transcode \
+    # -e PLEX_CLAIM: XXXXXXXXXXXXXXXXXXXXXXXXXX # Optional -> https://www.plex.tv/claim/
+    -v /docker/plex/config:/config \
+    -v /docker/plex/transcode:/transcode \ # Optional
     --privileged \
     --cap-add MKNOD \
     --cap-add SYS_ADMIN \
@@ -89,79 +70,118 @@ docker run --name Plex -h Plex -d \
     rapejim/pms-plexdrive-docker
 ```
 
-***NOTA:*** *Debes reemplazar `Europe/Madrid` por tu zona horaria y las rutas
-de los volúmenes `/docker/pms-plexdrive/...` por la que tienes en tu ordenador
-(en caso no uses la misma estructura de carpetas). Si tienes los archivos de
-configuración (`config.json` y ` token.json`) de una instalación anterior de
-Plexdrive, colocalos en la carpeta `docker/pms-plexdrive/config/.plexdrive`.*
+
+
+##### Docker-compose con red host
+
+```yaml
+version: '3.5'
+services:
+  plex:
+    container_name: plex
+    image: rapejim/pms-plexdrive-docker:latest # https://hub.docker.com/r/rapejim/pms-plexdrive-docker
+    restart: unless-stopped
+    privileged: true
+    network_mode: host
+    volumes:
+      - /docker/plex/config:/config
+      - /docker/plex/transcode:/transcode # Optional
+    environment:
+      TZ: 'Europe/Madrid'
+      PLEX_UID : '1000'
+      PLEX_GID : '1000'
+      # PLEX_CLAIM: XXXXXXXXXXXXXXXXXXXXXXXXXX # Optional -> https://www.plex.tv/claim/
+    cap_add:
+      - MKNOD
+      - SYS_ADMIN
+    devices:
+      - '/dev/fuse'
+```
+
+##### Docker-compose con red bridge
+
+```yaml
+version: '3.5'
+services:
+  plex:
+    container_name: plex
+    hostname: Plex
+    image: rapejim/pms-plexdrive-docker:latest # https://hub.docker.com/r/rapejim/pms-plexdrive-docker
+    restart: unless-stopped
+    privileged: true
+    network_mode: bridge
+    ports: 
+      - 32400:32400
+      # - 1900:1900 # Optional
+      # - 3005:3005 # Optional
+      # - 8324:8324 # Optional
+      # - 32410:32410 # Optional
+      # - 32412:32412 # Optional
+      # - 32413:32413 # Optional
+      # - 32414:32414 # Optional
+      # - 32469:32469 # Optional
+    volumes:
+      - /docker/plex/config:/config
+      - /docker/plex/transcode:/transcode # Optional
+    environment:
+      TZ: 'Europe/Madrid'
+      PLEX_UID : '1000'
+      PLEX_GID : '1000'
+      # PLEX_CLAIM: XXXXXXXXXXXXXXXXXXXXXXXXXX # Optional -> https://www.plex.tv/claim/
+    cap_add:
+      - MKNOD
+      - SYS_ADMIN
+    devices:
+      - '/dev/fuse'
+```
+
+
+
+***NOTA:*** *Debes reemplazar `Europe/Madrid` por tu zona horaria y las rutas de los volúmenes `/docker/plex/...` por tus propias rutas (si no usas la misma estructura de carpetas). Si tienes archivos de configuración (`config.json` y ` token.json`) de una instalación anterior de Plexdrive, colócalos previamente en la carpeta `docker/plex/config/.plexdrive`.*
 <br/>
 <br/>
 <br/>
 
 ## *Primer uso y configuración inicial*
 ---
 
-En la primera ejecución del contenedor (si no tienes archivos de configuración de una
-instalación previa) debes entrar en la consola del contenedor, 
-copiar, pegar y ejecutar el siguiente comando:
+En la primera ejecución del contenedor (si no tienes archivos de configuración de una instalación previa) debes entrar en la consola del contenedor, copiar, pegar y ejecutar el siguiente comando:
 
 ```bash
 plexdrive mount -c ${HOME}/${PLEXDRIVE_CONFIG_DIR} --cache-file=${HOME}/${PLEXDRIVE_CONFIG_DIR}/cache.bolt -o allow_other ${PLEXDRIVE_MOUNT_POINT} {EXTRA_PARAMS}
 ```
 
 Este comando iniciará un asistente de configuración:
 
-- Solicitará tu `Client ID` y `Client Secret`
-- Te mostrará un enlace para iniciar sesión con tu cuenta de Google Drive (la
-  que utilizaste para obtener los `Client ID` y `Client Secret`).
-- El sitio web del enlace anterior, te mostrará un token que debes copiar y
-  pegar en el terminal.
-- Cuando completes el proceso, Plexdrive comienzará a almacenar en caché los
-  archivos de tu cuenta de Google Drive en el segundo plano. No es necesario
-  esperar a que Plexdrive complete su proceso inicial de creación de caché en
-  esta consola. Ahora que los archivos `config.json` y ` token.json` fueron
-  creados, puedes salir de la terminal (*Cntrl+C*).
-
-***NOTA:*** *Si estas ejecutando este contenedor en una computadora remota
-(fuera de la red local), se recomienda utilizar la variable de entorno
-`PLEX_CLAIM` de la
-[imagen Docker oficial PMS](https://github.com/plexinc/pms-docker) para vincular
-este nuevo servidor a su propia cuenta en la primer ejecución.*
+- Primero solicitará tus `Client ID` y `Client Secret`
+- Te mostrará un enlace para iniciar sesión con tu cuenta de Google Drive (la misma de los `Client ID` y `Client Secret`).
+- El sitio web del enlace anterior, te mostrará un token que debes copiar y pegar en el terminal.
+- Cuando completes el proceso, Plexdrive comienzará a almacenar en caché los archivos de tu cuenta de Google Drive en el segundo plano. No es necesario esperar a que Plexdrive complete su proceso inicial de creación de caché en esta consola. Ahora que los archivos `config.json` y ` token.json` fueron creados, puedes salir de la terminal (*Ctrl+C*).
+
+***NOTA:*** *Si estas ejecutando este contenedor en una computadora remota (fuera de la red local), se recomienda utilizar la variable de entorno `PLEX_CLAIM` de la [imagen docker oficial PMS](https://github.com/plexinc/pms-docker) para vincular este nuevo servidor a su propia cuenta en la primer ejecución.*
 <br/>
 <br/>
 <br/>
 
 ## *Parámetros*
 ---
 
-Estos parámetros, no son necesarios a menos que desees conservar la estructura de carpetas
-actual o mantener permisos de archivo especiales.
-
-- `PLEXDRIVE_CONFIG_DIR` Establece el nombre de la carpeta de configuración de
-  Plexdrive que se encuentra dentro de la carpeta de configuración de PMS. El
-  valor predeterminado es `.plexdrive`.
-- `PLEXDRIVE_MOUNT_POINT` Establece el nombre del punto de montaje interno de
-  Plexdrive. El valor predeterminado es `/home/Plex`.
-- `CHANGE_PLEXDRIVE_CONFIG_DIR_OWNERSHIP` Define si el contenedor debe intentar
-  corregir los permisos de los archivos de configuración de Plexdrive existentes.
-- `PLEX_UID` y `PLEX_GID` Establece el ID de usuario y el ID de grupo para el
-  usuario de `Plex`. Útil si deseas que coincidan con los de su propio usuario
-  en el ordenador.
-- `EXTRA_PARAMS` Permite agregar parámetros más avanzados para que Plexdrive
-  pueda montar el comando inicial. Por ejemplo puedes utilizar:
-  - `--drive-id=ABC123qwerty987` para montar la **Unidad Compartida** con el
-  identificador `ABC123qwerty987`
-  - `--root-node-id=DCBAqwerty987654321_ASDF123456789` para un montar solo el
-  subdirectorio con el identificador `DCBAqwerty987654321_ASDF123456789`
+Estos parámetros no son necesarios, solo si deseas usar una estructura de carpetas actual o permisos de archivo especiales.
+
+- `PLEXDRIVE_CONFIG_DIR` Establece la carpeta de configuración de Plexdrive dentro de la carpeta de configuración de PMS. Valor predeterminado `.plexdrive`.
+- `PLEXDRIVE_MOUNT_POINT` Establece el nombre del punto de montaje interno de Plexdrive.
+  Valor predeterminado  `/home/Plex`.
+- `CHANGE_PLEXDRIVE_CONFIG_DIR_OWNERSHIP` Determina si el contenedor debe intentar corregir los permisos de los archivos de configuración de Plexdrive existentes.
+- `PLEX_UID` y `PLEX_GID` Establece el ID de usuario y el ID de grupo para el usuario de `Plex`. Útil si deseas que coincidan con los de su propio usuario en el ordenador.
+- `EXTRA_PARAMS` Agrega parámetros avanzados a Plexdrive  para usar en el comando inicial de montaje. Por ejemplo:
+  - `--drive-id=ABC123qwerty987` para montar la **Unidad Compartida** con el identificador `ABC123qwerty987`
+  - `--root-node-id=DCBAqwerty987654321_ASDF123456789` para un montar solo el subdirectorio con el identificador `DCBAqwerty987654321_ASDF123456789`
   - *[... Documentación de Plexdrive para más información ...](https://github.com/plexdrive/plexdrive#usage)*
-  -  **IMPORTANTE:** *No está permitido utilizar los parámetros
-  "`-v` `--verbosity`", "`-c` `--config`", "`--cache-file`" ó
-  "`-o` `--fuse-options`", porque ya se usan internamente.*
-<br/>
-<br/>
+  -  **IMPORTANTE:** *No está permitido utilizar los parámetros "`-v` `--verbosity`", "`-c` `--config`", "`--cache-file`", ni tampoco "`-o` `--fuse-options`", porque ya se usan internamente.*
+  <br/>
+  <br/>
 
-***RECUERDA:*** *También se heredan todas las opciones originales del contenedor oficial de PMS.
-[Consulta la documentación de PMS para obtener más información](https://hub.docker.com/r/plexinc/pms-docker).*
+***RECUERDA:*** *También se heredan todas las opciones del contenedor oficial de PMS. [Documentación de PMS para más información](https://hub.docker.com/r/plexinc/pms-docker).*
 <br/>
 <br/>
 <br/>
@@ -170,9 +190,8 @@ actual o mantener permisos de archivo especiales.
 ---
 
 ```bash
-$ tree
 Docker Data Folder
-├── pms-plexdrive
+├── plex
 │   ├── config
 │   │   ├── .plexdrive
 │   │   │   └── ...
@@ -190,6 +209,6 @@ Docker Data Folder
 
 Las etiquetas corresponden a las del contenedor Docker oficial de PMS:
 
-- `public` — Lanzamiento público de PMS.
-- `beta` — Lanzamiento beta de PMS ***(Requiere Plex Pass)***.
-- `latest` — Actualmente lo mismo que `public`.
+- `public` — Versión públicas de PMS.
+- `beta` — Versión beta de PMS ***(Requiere Plex Pass)***.
+- `latest` — Actualmente la misma que `public`.