This repository has been archived on 2025-02-18. You can view files and clone it, but cannot push or open issues or pull requests.
pontus-mail/README.md
2024-12-09 21:10:46 -05:00

1.5 KiB

pontus-mail

License: CC0-1.0

Landing page for p0ntus mail

Self hosting

Traditional Node.js

  1. Clone the repo
    git clone https://github.com/ihatenodejs/pontus-mail.git
    cd pontus-mail
    
  2. Copy the example docker-compose.yml
    mv docker-compose.yml.example docker-compose.yml
    
  3. Copy the example donations.json
    mv donations.json.example donations.json
    
  4. Install dependencies
    npm install
    
  5. Start the server
    node app.js
    

You will now have a fully functioning Node.js Express server, which will be running on port 3000.

With Docker

You can also use Docker to self-host pontus-mail's frontend. Make sure you have docker-compose or docker-compose-plugin installed on your system.

  1. Clone the repo
    git clone https://github.com/ihatenodejs/pontus-mail.git
    cd pontus-mail
    
  2. Copy the example docker-compose.yml
    mv docker-compose.yml.example docker-compose.yml
    
  3. Copy the example donations.json
    mv donations.json.example donations.json
    
  4. Start and build Docker containers
    docker compose up -d --build
    

You will now have a fully functioning Node.js Express server, which will be running on the port specified in docker-compose.yml, and internally on port 3000.