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-03 01:24:35 -05:00

51 lines
1.4 KiB
Markdown

# pontus-mail
Landing page for p0ntus mail
# Self hosting
## Traditional Node.js
1. Clone the repo
```bash
git clone https://github.com/ihatenodejs/pontus-mail.git
cd pontus-mail
```
2. Copy the example `docker-compose.yml`
```bash
mv docker-compose.yml.example docker-compose.yml
```
3. Make the `self` script executable
```bash
chmod +x self
```
4. Use `self` script to serve files into `public/` directory
```bash
./self start
```
You will now have to use a server (NGINX, Apache2, etc.) to serve files from the `./public` directory.
Make changes from the `./src` directory, and `self` will copy them over.
## 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
```bash
git clone https://github.com/ihatenodejs/pontus-mail.git
cd pontus-mail
```
2. Copy the example `docker-compose.yml`
```bash
mv docker-compose.yml.example docker-compose.yml
```
3. Make the `self` script executable
```bash
chmod +x self
```
4. Start Docker containers
```bash
docker compose up -d
```
5. Use `self` script to serve files into `public/` directory
```bash
./self start
```
You will now have a fully functioning NGINX server, serving the pontus-mail website from the `./public` directory. Make your changes in the `./src` directory, if any.