Improve Installation/Configuration

[Jniklas2]

I've tried to install it in the last few days, but it seems like there are missing variables in your example. Also you should explain what each variable is for, because some names are not very clear. Another thing I've noticed is, you set some environment variables but also include the .env file which contains those same values.

And one question, which I couldn't test: Can every user just add new mailboxes without any verification (except maybe via ALLOWED_EMAIL_DOMAINS)?

I archived this with my IdP directly (authentik, saw you on the discord with the same issue, do you want my solution?), so I probably won't try this again, but I wanted to share my experiences with it :)

[CodeShellDev]

Hey there @Jniklas2,
Honored to see you here! (And sorry to hear it did not work out :( )

Yes, the configuration and setup is very crude (Basically just threw everything into the .env file and called it a day 😅),
since I am currently in a flow of development this would also be my next target.
Same thing with the env_file, of course, this doesn‘t need to be there, I was planning on migrating that too!
Yes the env variable allowed_email_domains is currently a very rudimentary thing, I am planning on expanding this.

Just checked, indeed you 👍-ed my discord thread, also would be interested in your setup 😁.
Though would you mind attaching the error you got or the issues you stumbled upon?

CSD out 👋

[CodeShellDev]

# Mail

MAIL_CLIENT_ID=_
MAIL_CLIENT_SECRET=_

MAIL_AUTHORIZATION_ENDPOINT=https://authentication.domain.com/application/o/authorize/
MAIL_TOKEN_ENDPOINT=https://authentication.domain.com/application/o/token/
MAIL_USERINFO_ENDPOINT=https://authentication.domain.com/application/o/userinfo/

MAIL_REDIRECT_URIS=https://mail.domain.com/mailman/oauth/mail/callback
MAIL_CALLBACK_URIS=https://mail.domain.com

# App

APP_CLIENT_ID=_
APP_CLIENT_SECRET=_

APP_ISSUER=https://authentication.domain.com/application/o/mailbox-manager/

APP_AUTHORIZATION_ENDPOINT=https://authentication.domain.com/application/o/authorize/
APP_TOKEN_ENDPOINT=https://authentication.domain.com/application/o/token/
APP_USERINFO_ENDPOINT=https://authentication.domain.com/application/o/userinfo/
APP_LOGOUT_ENDPOINT=https://authentication.domain.com/application/o/mailbox-manager/end-session/

APP_REDIRECT_PATH=/mailman/oauth/app/callback

Disclaimer:
I have mailbaux on a path prefix!

[Jniklas2]

Just checked, indeed you 👍-ed my discord thread, also would be interested in your setup 😁.

Do you want it here or over on the (very old) discord thread?

Though would you mind attaching the error you got or the issues you stumbled upon?

I stupidly didn't saved the error message and currently can't reproduce it but it was something like "variable app not set" or something similar. Maybe you fixed that with a recent update. I think the v1.1.0 was the latest I tried (btw: have you rereleased that release?)

[CodeShellDev]

Yes I have I think there was an issue with my build workflow!

[CodeShellDev]

Ah yes my config management was kind of broken, sorry for that!

[CodeShellDev]

@Jniklas2, would you mind sharing your setup here: https://github.com/CodeShellDev/mailbaux/discussions/categories/show-and-tell

[CodeShellDev]

In order of the fields:
Authorize URL: […]/mailman/oauth/authorize
Token URL: […]/mailman/oauth/token
Userinfo URL: […]/mailman/oauth/userinfo

Redirect URL: […]/mailman/oauth/mail/callback

[CodeShellDev]

Btw., do you perhaps still have your old setup files? This way I could maybe trace back the error or try to reproduce it myself

[Jniklas2]

My compose file is this:

compose.yml

services:
  mailauth:
    image: ghcr.io/codeshelldev/mailauth:latest
    env_file:
      - .env
    labels:
      - traefik.enable=true
      - traefik.http.routers.mailauth.rule=Host(`mailauth.example.net`)
      - traefik.http.services.mailauth.loadbalancer.server.port=8070
    depends_on:
      mongodb:
        condition: service_healthy
      redis:
        condition: service_healthy
    restart: unless-stopped
    networks:
      mailauth:
      traefik-net:

  mongodb:
    image: mongo:8-noble
    environment:
      MONGO_INITDB_ROOT_USERNAME: ${DB_USER:-admin}
      MONGO_INITDB_ROOT_PASSWORD: ${DB_PASSWORD:?MongoDB Password is not set}
      MONGO_INITDB_DATABASE: ${DB_NAME:-mailauth}
    volumes:
      - db-data:/data/db
    networks:
      mailauth:
    restart: unless-stopped
    healthcheck:
      test: ["CMD-SHELL", "mongosh admin -u $$MONGO_INITDB_ROOT_USERNAME -p $$MONGO_INITDB_ROOT_PASSWORD --eval \"db.adminCommand('ping')\" --quiet"]
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 20s
      start_interval: 1s

  redis:
    image: redis:8-alpine
    command: ["redis-server", "--requirepass", "${REDIS_PASSWORD}"]
    environment:
      REDIS_PASSWORD: ${REDIS_PASSWORD:?Redis Password is not set}
    networks:
      mailauth:
    restart: unless-stopped
    healthcheck:
      test: ["CMD-SHELL", "REDISCLI_AUTH=\"$$REDIS_PASSWORD\" redis-cli ping | grep PONG"]
      interval: 10s
      timeout: 3s
      retries: 3
      start_period: 5s
      start_interval: 1s

networks:
  mailauth:
    internal: true
  traefik-net:
    external: true

volumes:
  db-data:

And for the .env file, I basically used just the example from your README. I just replaced the values there and that should be it.

For the compose file:

1. I removed the container_name because it's bad practice in my opinion.
2. I added healthchecks to both redis and mongodb
3. I changed some variables to be required to be set
4. I added the traefik configuration. In my configs, I only need two lines (or three, when the application uses custom ports) because most things are in the static config defined (like default entrypoint, encryption, network and such).

[CodeShellDev]

Would you mind still sharing the env file (with values redacted of course)?

[CodeShellDev]

Quick question: Did you run mailbaux with the version before v1.1.0? Since I had to reset my volumes for v1.1.0 (didn‘t mention the breaking change).

(Database structure was changed)

[Jniklas2]

@Jniklas2, would you mind sharing your setup here: https://github.com/CodeShellDev/mailbaux/discussions/categories/show-and-tell

@CodeShellDev I have shared it here: #15

[CodeShellDev]

so I probably won't try this again, but I wanted to share my experiences with it :)

Sorry for bombing you with all these questions 😅, but could maybe try it with the latest version? (if you find time, of course!) I really want to get to the bottom of this, since these kind of issues obviously deter new users (rightfully so…).