fix(protonmail-bridge) add installations docs + added imap port. (#4158)

* fix(protonmail-bridge) add installations docs + added imap

* update ver to v2.3.0 | major upgrade.

* cleanup

* fix commands in docs

Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
This commit is contained in:
Xstar97
2022-10-22 23:37:24 +03:00
committed by GitHub
co-authored by Stavros Kois
parent 058a19cae9
commit 30c0b87280
4 changed files with 84 additions and 25 deletions
+2 -2
View File
@@ -1,5 +1,5 @@
apiVersion: v2 apiVersion: v2
appVersion: "1.8.10" appVersion: "2.3.0"
dependencies: dependencies:
- name: common - name: common
repository: https://library-charts.truecharts.org repository: https://library-charts.truecharts.org
@@ -20,7 +20,7 @@ sources:
- https://github.com/truecharts/charts/tree/master/charts/stable/protonmail-bridge - https://github.com/truecharts/charts/tree/master/charts/stable/protonmail-bridge
- https://github.com/shenxn/protonmail-bridge-docker - https://github.com/shenxn/protonmail-bridge-docker
- https://hub.docker.com/r/shenxn/protonmail-bridge - https://hub.docker.com/r/shenxn/protonmail-bridge
version: 6.0.37 version: 7.0.0
annotations: annotations:
truecharts.org/catagories: | truecharts.org/catagories: |
- media - media
@@ -0,0 +1,23 @@
# Installation Notes
- In order to run this chart, you need to be a _paid_ end-user for [proton](https://proton.me/mail/bridge).
- Shell into the app after installing it to complete the login phase.
- Run the following commands in order:
```terminal
chmod +x entrypoint.sh && ps aux | grep [b]ridge | awk '{print $2}' | xargs -I {} kill -9 {} && ./entrypoint.sh init
```
```terminal
login
```
- You can then login with your username and password.
:::tip
To save time and energy, you can paste the password by holding SHIFT and pressing INSERT.
Password field is still blank, just hit enter as normal.
:::
+51 -22
View File
@@ -13,21 +13,21 @@ questions:
# Include{containerConfig} # Include{containerConfig}
# Include{serviceRoot} # Include{serviceRoot}
- variable: main - variable: main
label: "main Service" label: main Service
description: "The main service" description: The main service
schema: schema:
type: dict type: dict
hidden: true hidden: true
attrs: attrs:
- variable: enabled - variable: enabled
label: "Enable the service" label: Enable the service
schema: schema:
type: boolean type: boolean
default: false default: false
hidden: true hidden: true
- variable: smtp - variable: smtp
label: "smtp Service" label: SMTP Service
description: "The smtp service" description: The smtp service
schema: schema:
additional_attrs: true additional_attrs: true
type: dict type: dict
@@ -35,33 +35,62 @@ questions:
# Include{serviceSelectorLoadBalancer} # Include{serviceSelectorLoadBalancer}
# Include{serviceSelectorExtras} # Include{serviceSelectorExtras}
- variable: smtp - variable: smtp
label: "smtp Service Port Configuration" label: SMTP Service Port Configuration
schema: schema:
additional_attrs: true additional_attrs: true
type: dict type: dict
attrs: attrs:
- variable: port - variable: port
label: "Port" label: Port
description: "This port exposes the container port on the service" description: This port exposes the container port on the service
schema: schema:
type: int type: int
default: 25 default: 25
required: true required: true
# Include{advancedPortTCP} # Include{advancedPortTCP}
- variable: targetPort - variable: targetPort
label: "Target Port" label: Target Port
description: "The internal(!) port on the container the Application runs on" description: The internal(!) port on the container the Application runs on
schema: schema:
type: int type: int
default: 25 default: 25
- variable: imap
label: IMAP Service
description: The IMAP service
schema:
additional_attrs: true
type: dict
attrs:
# Include{serviceSelectorLoadBalancer}
# Include{serviceSelectorExtras}
- variable: imap
label: IMAP Service Port Configuration
schema:
additional_attrs: true
type: dict
attrs:
- variable: port
label: Port
description: This port exposes the container port on the service
schema:
type: int
default: 143
required: true
# Include{advancedPortTCP}
- variable: targetPort
label: Target Port
description: The internal(!) port on the container the Application runs on
schema:
type: int
default: 143
# Include{serviceExpertRoot} # Include{serviceExpertRoot}
default: false default: false
# Include{serviceExpert} # Include{serviceExpert}
# Include{serviceList} # Include{serviceList}
# Include{persistenceRoot} # Include{persistenceRoot}
- variable: config - variable: config
label: "App Config Storage" label: App Config Storage
description: "Stores the Application Configuration." description: Stores the Application Configuration.
schema: schema:
additional_attrs: true additional_attrs: true
type: dict type: dict
@@ -73,42 +102,42 @@ questions:
# Include{security} # Include{security}
# Include{securityContextAdvancedRoot} # Include{securityContextAdvancedRoot}
- variable: privileged - variable: privileged
label: "Privileged mode" label: Privileged mode
schema: schema:
type: boolean type: boolean
default: false default: false
- variable: readOnlyRootFilesystem - variable: readOnlyRootFilesystem
label: "ReadOnly Root Filesystem" label: ReadOnly Root Filesystem
schema: schema:
type: boolean type: boolean
default: false default: false
- variable: allowPrivilegeEscalation - variable: allowPrivilegeEscalation
label: "Allow Privilege Escalation" label: Allow Privilege Escalation
schema: schema:
type: boolean type: boolean
default: false default: false
- variable: runAsNonRoot - variable: runAsNonRoot
label: "runAsNonRoot" label: runAsNonRoot
schema: schema:
type: boolean type: boolean
default: false default: false
# Include{securityContextAdvanced} # Include{securityContextAdvanced}
# Include{podSecurityContextRoot} # Include{podSecurityContextRoot}
- variable: runAsUser - variable: runAsUser
label: "runAsUser" label: runAsUser
description: "The UserID of the user running the application" description: The UserID of the user running the application
schema: schema:
type: int type: int
default: 0 default: 0
- variable: runAsGroup - variable: runAsGroup
label: "runAsGroup" label: runAsGroup
description: "The groupID this App of the user running the application" description: The groupID this App of the user running the application
schema: schema:
type: int type: int
default: 0 default: 0
- variable: fsGroup - variable: fsGroup
label: "fsGroup" label: fsGroup
description: "The group that should own ALL storage." description: The group that should own ALL storage.
schema: schema:
type: int type: int
default: 568 default: 568
+8 -1
View File
@@ -1,6 +1,6 @@
image: image:
repository: tccr.io/truecharts/protonmail-bridge repository: tccr.io/truecharts/protonmail-bridge
tag: v1.8.10-1@sha256:58a54002123cc9a83cfb3170deb0a1dbf4cedabdced09a9c6bcafc19ee4b5631 tag: v2.3.0@sha256:539b1c9188dfccd2bc10efa63e4e009ec8ac131732bcfa0d596c1ca37ba84816
pullPolicy: IfNotPresent pullPolicy: IfNotPresent
securityContext: securityContext:
@@ -24,6 +24,13 @@ service:
enabled: true enabled: true
port: 25 port: 25
targetPort: 25 targetPort: 25
imap:
enabled: true
ports:
imap:
enabled: true
port: 143
targetPort: 143
persistence: persistence:
config: config: