Skip to content
This repository has been archived by the owner on Oct 25, 2024. It is now read-only.
/ hydroxide-docker Public archive

Docker configuration examples for the hydroxide package

Notifications You must be signed in to change notification settings

ma-04/hydroxide-docker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 

Repository files navigation

This repository is deprecated in favor of separate repository

ci

Hydroxide Dockerfile

This repository provides an example Dockerfile configuration for hydroxide.

Before submitting issues, please see the hydroxide docs and Protomail support pages for hydroxide and Protonmail specific matters.

I offer no guarentees that this is a secure way to store and pass your hydroxide authentication information to other apps. It is one working example to get you started. If you can improve the security of this example configuration, please send a pull request.

Setup

Below are some basic instructions to get you started.

Running hydroxide as a Docker container

First, you need to run the container and link it to your other apps. You can do this with docker run or docker-compose.

docker run:

docker run -it -d --user 1000 -p 1025:1025 -p 1143:1143 -p 8080:8080 -v ./hydroxide-data:/hydroxide --name hydroxide ma04/hydroxide:latest serve

Ports: 1025: SMTP server (for sending emails), 1143: IMAP server (for receiving emails), 8080: Carddav HTTP server

WARNING: you may need to create the folder first as a non root user in your system, still working on the fix After running the container, you need to login to your Protonmail account with your proton username. You can do this by running:

docker exec -it hydroxide hydroxide auth <proton user name>

IMPORTANT: You must run the container with the --user 1000(your user id) flag. This is because the container runs as 101 by default and if your user id is not 101, hydroxide will run into filesystem permission error.

to get your user id, run the following command:

id -u

todo: fix the default user id to 1000 or better yet, make it configurable. (still an issue ig :( )

Docker-Compose

If you require a docker-compose file, see docker-compose.yml. If you are unfamiliar with docker-compose, here is some code to get you started.

Navigate to this repo by changing the directory

cd hydroxide-docker

Create a folder for the data

mkdir hydroxide_data

make appropriate changes to the docker-compose.yml file and then run the following commands

docker-compose up -d

After running the container, you need to login to your Protonmail account with your proton username. You can do this by running:

docker exec -it hydroxide hydroxide auth <proton username>

or you can use your existing hydroxide by moving it inside the hydroxide-data folder and restarting/starting the container

About

Docker configuration examples for the hydroxide package

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published