{"id":22832562,"url":"https://github.com/waldner/snappymail-docker","last_synced_at":"2025-04-23T21:25:26.540Z","repository":{"id":92012194,"uuid":"203002828","full_name":"waldner/snappymail-docker","owner":"waldner","description":"Docker image for the snappymail webmail client, with optional SSL and HTTP auth","archived":false,"fork":false,"pushed_at":"2024-10-24T11:30:13.000Z","size":15,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-30T03:41:15.574Z","etag":null,"topics":["docker","docker-compose","http-auth","https","snappymail"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/waldner.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-08-18T12:53:27.000Z","updated_at":"2024-11-21T18:55:02.000Z","dependencies_parsed_at":null,"dependency_job_id":"279d10d9-7c8e-4778-82b6-03c8788c65bb","html_url":"https://github.com/waldner/snappymail-docker","commit_stats":null,"previous_names":["waldner/snappymail-docker"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waldner%2Fsnappymail-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waldner%2Fsnappymail-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waldner%2Fsnappymail-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waldner%2Fsnappymail-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/waldner","download_url":"https://codeload.github.com/waldner/snappymail-docker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250516055,"owners_count":21443543,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-compose","http-auth","https","snappymail"],"created_at":"2024-12-12T21:08:01.051Z","updated_at":"2025-04-23T21:25:26.521Z","avatar_url":"https://github.com/waldner.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# snappymail-docker\n\n### What's this?\n\n`Dockerfile` and compose file to run the [snappymail](https://snappymail.eu) webmail client.\n\nThe image lives at [ghcr.io](https://github.com/waldner/snappymail-docker/pkgs/container/snappymail-docker).\n\n### Using the image\n\n- If you cloned the github repository, skip this step. Otherwise create a file `docker-compose.yml` with the following content:\n\n```\nservices:\n  snappymail:\n    image: ghcr.io/waldner/snappymail-docker:latest\n    container_name: snappymail\n    hostname: snappymail\n    volumes:\n      - ${WEBMAIL_DATA}:/snappymail/data\n    ports:\n      - ${EXTERNAL_HTTP_PORT:-80}:80\n    environment:\n      - TZ=${TZ:-UTC}\n      - USE_SSL=${USE_SSL:-0}\n      - HTTP_AUTH_USER=${HTTP_AUTH_USER:-}\n      - HTTP_AUTH_PASS=${HTTP_AUTH_PASS:-}\n      - UPLOAD_MAX_SIZE=${UPLOAD_MAX_SIZE:-10m}\n```\n\n- Create a file named `.env` (in the same place where you put the `docker-compose.yml` file) with the following content:\n\n```\n# mandatory: where the data volume for rainloop is in the host filesystem\nWEBMAIL_DATA=/path/to/snappymail/data\n\n# optional: maximum attachment/upload size, default 10m\nUPLOAD_MAX_SIZE=20m\n\n# optional: if you want HTTP auth, put credentials in here,\n# otherwise don't define these two variables\nHTTP_AUTH_USER=myuser\nHTTP_AUTH_PASS=mypass\n\n# optional: time zone (default: UTC)\nTZ=Europe/Berlin\n\n# optional: which host port will be exposed for HTTP requests (default: 80)\nEXTERNAL_HTTP_PORT=8080\n\n# optional: whether to enable ssl (default: 0)\nUSE_SSL=1\n\n# mandatory if USE_SSL=1: TLS certificate and key locations in local filesystem\nLOCAL_SSL_CERT=/path/to/server.crt\nLOCAL_SSL_KEY=/path/to/server.key\n\n# optional: which host port will be exposed for HTTPS requests (default: 443)\n# only used if USE_SSL=1\nEXTERNAL_HTTPS_PORT=8443\n\n# optional: whether to generate and use a custom dhparams.pem file at startup (default: 1)\n# this may make the boot process longer\nDHPARAMS=0\n\n```\n\n- If you want to use SSL (`USE_SSL=1`) and thus assigned values to `LOCAL_SSL_CERT` and `LOCAL_SSL_KEY` (and possibly `EXTERNAL_HTTPS_PORT`): create a `docker-compose.override.yml` in the same directory with the following content (or, if you cloned the repo, just run `cp docker-compose.override.yml.sample docker-compose.override.yml`):\n\n```\nservices:\n  snappymail:\n    ports:\n      - ${EXTERNAL_HTTPS_PORT:-443}:443\n    volumes:\n      - ${LOCAL_SSL_CERT}:/etc/nginx/server.crt\n      - ${LOCAL_SSL_KEY}:/etc/nginx/server.key\n    environment:\n      EXTERNAL_HTTPS_PORT: ${EXTERNAL_HTTPS_PORT:-443}\n      DHPARAMS: ${DHPARAMS:-1}\n```\n\n- Run the image with `docker compose up -d`\n\n### Getting started\n\nAs explained in [the docs](https://github.com/the-djmaze/snappymail/wiki/Installation-instructions#now-access-the-admin-page), to perform the initial configuration you have to go to `http[s]://your.domain.tld:yourport/?admin` and follow the instruction in the wiki page. The initial username is `admin`, the initial password is in `/snappymail/data/_data_/_default_/admin_password.txt` (inside the container).\n\n### Miscellaneous\n\n- When using SSL, all incoming requests to `$HTTP_EXTERNAL_PORT` are redirected to the HTTPS version of the page on port `$HTTPS_EXTERNAL_PORT`.\n- All daemons log to stdout, so you can use `docker logs` to see the messages.\n- Internally, the container runs [nginx](http://nginx.org/) and [php-fpm](https://www.php.net/), controlled by [supervisord](http://supervisord.org/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwaldner%2Fsnappymail-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwaldner%2Fsnappymail-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwaldner%2Fsnappymail-docker/lists"}