This commit is contained in:
Echo Nar 2025-12-22 12:31:03 +00:00 committed by GitHub
commit 4ed2589796
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 75 additions and 39 deletions

View File

@ -34,10 +34,10 @@ tag | description
To initialize and add account to the bridge, run the following command. To initialize and add account to the bridge, run the following command.
``` ```
docker run --rm -it -v protonmail:/root shenxn/protonmail-bridge init docker run --rm -it -e KEYRING_PASSPHRASE='<your_passphrase>' -v protonmail:/root shenxn/protonmail-bridge init
``` ```
If you want to use Docker Compose instead, you can create a copy of the provided example [docker-compose.yml](docker-compose.yml) file, modify it to suit your needs, and then run the following command: If you want to use Docker Compose instead, you can create a copy of the provided example [docker-compose.yml](docker-compose.yml) file, modify it to suit your needs (making sure KEYRING_PASSPHRASE matches what was used during intitialization), and then run the following command:
``` ```
docker compose run protonmail-bridge init docker compose run protonmail-bridge init
@ -50,7 +50,7 @@ Wait for the bridge to startup, then you will see a prompt appear for [Proton Ma
To run the container, use the following command. To run the container, use the following command.
``` ```
docker run -d --name=protonmail-bridge -v protonmail:/root -p 1025:25/tcp -p 1143:143/tcp --restart=unless-stopped shenxn/protonmail-bridge docker run -d --name=protonmail-bridge -e KEYRING_PASSPHRASE='<your_passphrase>' -v protonmail:/root -p 1025:25/tcp -p 1143:143/tcp --restart=unless-stopped shenxn/protonmail-bridge
``` ```
Or, if using Docker Compose, use the following command. Or, if using Docker Compose, use the following command.
@ -70,7 +70,7 @@ If you don't want to use Helm, you can also reference to the guide ([#6](https:/
Please be aware that running the command above will expose your bridge to the network. Remember to use firewall if you are going to run this in an untrusted network or on a machine that has public IP address. You can also use the following command to publish the port to only localhost, which is the same behavior as the official bridge package. Please be aware that running the command above will expose your bridge to the network. Remember to use firewall if you are going to run this in an untrusted network or on a machine that has public IP address. You can also use the following command to publish the port to only localhost, which is the same behavior as the official bridge package.
``` ```
docker run -d --name=protonmail-bridge -v protonmail:/root -p 127.0.0.1:1025:25/tcp -p 127.0.0.1:1143:143/tcp --restart=unless-stopped shenxn/protonmail-bridge docker run -d --name=protonmail-bridge -e KEYRING_PASSPHRASE='<your_passphrase>' -v protonmail:/root -p 127.0.0.1:1025:25/tcp -p 127.0.0.1:1143:143/tcp --restart=unless-stopped shenxn/protonmail-bridge
``` ```
Besides, you can publish only port 25 (SMTP) if you don't need to receive any email (e.g. as a email notification service). Besides, you can publish only port 25 (SMTP) if you don't need to receive any email (e.g. as a email notification service).

View File

@ -1,13 +1,36 @@
#!/bin/bash #!/bin/bash
set -ex set -e
if [ -z "$KEYRING_PASSPHRASE" ]; then
echo "KEYRING_PASSPHRASE cannot be empty"
exit 1
fi
gpg_present_phrase () {
/usr/lib/gnupg2/gpg-preset-passphrase -P "$KEYRING_PASSPHRASE" \
-c "$(basename "$HOME"/.gnupg/private-keys-v1.d/*.key .key)"
}
# Start gpg-agent to force allow presetting passphrase
gpg-agent --homedir "$HOME"/.gnupg --daemon --allow-preset-passphrase
# Initialize # Initialize
if [[ $1 == init ]]; then if [[ $1 == init ]]; then
# Initialize pass # Initialize GPG if no private key
gpg --generate-key --batch /protonmail/gpgparams # While -f can't handle globs, only one key can be generated
pass init pass-key if [ ! -f "$HOME"/.gnupg/private-keys-v1.d/*.key ]; then
gpg --generate-key --passphrase "$KEYRING_PASSPHRASE" --pinentry-mode loopback \
--batch /protonmail/gpgparams
fi
# Initialize pass if no password-store
if [ ! -d "$HOME"/.password-store ]; then
pass init pass-key
fi
gpg_present_phrase
# Kill the other instance as only one can be running at a time. # Kill the other instance as only one can be running at a time.
# This allows users to run entrypoint init inside a running conainter # This allows users to run entrypoint init inside a running conainter
@ -16,9 +39,11 @@ if [[ $1 == init ]]; then
pkill protonmail-bridge || true pkill protonmail-bridge || true
# Login # Login
/protonmail/proton-bridge --cli $@ /protonmail/proton-bridge --cli
else else
# Load passphrase into gpg-agent
gpg_present_phrase
# socat will make the conn appear to come from 127.0.0.1 # socat will make the conn appear to come from 127.0.0.1
# ProtonMail Bridge currently expects that. # ProtonMail Bridge currently expects that.
@ -30,6 +55,6 @@ else
# Fake a terminal, so it does not quit because of EOF... # Fake a terminal, so it does not quit because of EOF...
rm -f faketty rm -f faketty
mkfifo faketty mkfifo faketty
cat faketty | /protonmail/proton-bridge --cli $@ cat faketty | /protonmail/proton-bridge --cli
fi fi

View File

@ -1,7 +1,6 @@
%no-protection
%echo Generating a basic OpenPGP key %echo Generating a basic OpenPGP key
Key-Type: RSA Key-Type: RSA
Key-Length: 2048 Key-Length: 4096
Name-Real: pass-key Name-Real: pass-key
Expire-Date: 0 Expire-Date: 0
%commit %commit

View File

@ -25,4 +25,4 @@ RUN apt-get update \
&& apt-get install -y --no-install-recommends /tmp/protonmail.deb socat pass libsecret-1-0 ca-certificates procps \ && apt-get install -y --no-install-recommends /tmp/protonmail.deb socat pass libsecret-1-0 ca-certificates procps \
&& rm -rf /var/lib/apt/lists/* && rm -rf /var/lib/apt/lists/*
CMD ["bash", "/protonmail/entrypoint.sh"] ENTRYPOINT ["bash", "/protonmail/entrypoint.sh"]

57
deb/entrypoint.sh Normal file → Executable file
View File

@ -1,38 +1,49 @@
#!/bin/bash #!/bin/bash
set -ex set -e
if [ -z "$KEYRING_PASSPHRASE" ]; then
echo "KEYRING_PASSPHRASE cannot be empty"
exit 1
fi
gpg_present_phrase () {
/usr/lib/gnupg2/gpg-preset-passphrase -P "$KEYRING_PASSPHRASE" \
-c "$(basename "$HOME"/.gnupg/private-keys-v1.d/*.key .key)"
}
# Start gpg-agent to force allow presetting passphrase
gpg-agent --homedir "$HOME"/.gnupg --daemon --allow-preset-passphrase
# Initialize # Initialize
if [[ $1 == init ]]; then if [[ $1 == init ]]; then
# # Parse parameters # Initialize GPG if no private key
# TFP="" # Default empty two factor passcode # While -f can't handle globs, only one key can be generated
# shift # skip `init` if [ ! -f "$HOME"/.gnupg/private-keys-v1.d/*.key ]; then
# while [[ $# -gt 0 ]]; do gpg --generate-key --passphrase "$KEYRING_PASSPHRASE" --pinentry-mode loopback \
# key="$1" --batch /protonmail/gpgparams
# case $key in fi
# -u|--username)
# USERNAME="$2"
# ;;
# -p|--password)
# PASSWORD="$2"
# ;;
# -t|--twofactor)
# TWOFACTOR="$2"
# ;;
# esac
# shift
# shift
# done
# Initialize pass # Initialize pass if no password-store
gpg --generate-key --batch /protonmail/gpgparams if [ ! -d "$HOME"/.password-store ]; then
pass init pass-key pass init pass-key
fi
gpg_present_phrase
# Kill the other instance as only one can be running at a time.
# This allows users to run entrypoint init inside a running conainter
# which is useful in a k8s environment.
# || true to make sure this would not fail in case there is no running instance.
pkill protonmail-bridge || true
# Login # Login
protonmail-bridge --cli protonmail-bridge --cli
else else
# Load passphrase into gpg-agent
gpg_present_phrase
# socat will make the conn appear to come from 127.0.0.1 # socat will make the conn appear to come from 127.0.0.1
# ProtonMail Bridge currently expects that. # ProtonMail Bridge currently expects that.

View File

@ -1,7 +1,6 @@
%no-protection
%echo Generating a basic OpenPGP key %echo Generating a basic OpenPGP key
Key-Type: RSA Key-Type: RSA
Key-Length: 2048 Key-Length: 4096
Name-Real: pass-key Name-Real: pass-key
Expire-Date: 0 Expire-Date: 0
%commit %commit

View File

@ -3,6 +3,8 @@ version: '2.1'
services: services:
protonmail-bridge: protonmail-bridge:
image: shenxn/protonmail-bridge image: shenxn/protonmail-bridge
environment:
- KEYRING_PASSPHRASE=
ports: ports:
- 1025:25/tcp - 1025:25/tcp
- 1143:143/tcp - 1143:143/tcp