Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Easier Installation page for both installation methods #420

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions apps/docs/pages/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# How To Install

# 1. Spearmint Installer

**Spearmint**, is a tool designed to simplify your setup process to install peppermint.


[Spearmint](https://spearmint.sh/) is a streamlined installer created by the talented developer [Sydney](https://syd.gg/). This tool is built with being user-friendly in mind and aims to make installations more accessible to people and businesses everywhere.

> **Note:** The Spearmint installer may occasionally be out of date or experience some issues. While **Peppermint** supports and endorses this tool, we cannot guarantee its full functionality or safety. Use it at your own discretion, and remember to exercise caution during installation.


# 2. Docker Install

Requirements:

- Docker
- Docker Compose

```docker
version: "3.1"

services:
peppermint_postgres:
container_name: peppermint_postgres
image: postgres:latest
restart: always
volumes:
- pgdata:/var/lib/postgresql/data
environment:
POSTGRES_USER: peppermint
POSTGRES_PASSWORD: 1234
POSTGRES_DB: peppermint

peppermint:
container_name: peppermint
image: pepperlabs/peppermint:latest
ports:
- 3000:3000
- 5003:5003
restart: always
depends_on:
- peppermint_postgres
environment:
DB_USERNAME: "peppermint"
DB_PASSWORD: "1234"
DB_HOST: "peppermint_postgres"
SECRET: 'peppermint4life'

volumes:
pgdata:
```

After you have created the docker-compose.yml file, run the following command:

```bash
docker-compose up -d
```

Then you can access the application at http://your-server-ip:3000

The default login credentials for the admin account are:

```
[email protected]
1234
```


Hey! Are you helping **Develop** on the [GitHub?](https://github.com/Peppermint-Lab/peppermint/) Please Refer to [This!](https://docs.peppermint.sh/development/)