mirror of
https://github.com/Portabase/portabase.git
synced 2026-07-14 11:16:13 +02:00
Working on the README.md
This commit is contained in:
@@ -35,14 +35,14 @@
|
|||||||
|
|
||||||
## 📚 Table of Contents
|
## 📚 Table of Contents
|
||||||
|
|
||||||
- [About The Project](#about-the-project)
|
- [About The Project](#-about-the-project)
|
||||||
- [Getting Started](#getting-started)
|
- [Getting Started](#-getting-started)
|
||||||
- [Usage](#usage)
|
- [Usage](#-usage)
|
||||||
- [Roadmap](#roadmap)
|
- [Roadmap](#-roadmap)
|
||||||
- [Contributing](#contributing)
|
- [Contributing](#-contributing)
|
||||||
- [License](#license)
|
- [License](#-license)
|
||||||
- [Contact](#contact)
|
- [Contact](#-contact)
|
||||||
- [Acknowledgments](#acknowledgments)
|
- [Acknowledgments](#-acknowledgments)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -59,6 +59,8 @@ GitHub Repository: [Portabase](https://github.com/Soluce-Technologies/portabase)
|
|||||||
- [![Drizzle][Drizzle]][Drizzle-url]
|
- [![Drizzle][Drizzle]][Drizzle-url]
|
||||||
- [![ShadcnUI][ShadcnUI]][ShadcnUI-url]
|
- [![ShadcnUI][ShadcnUI]][ShadcnUI-url]
|
||||||
- [![BetterAuth][BetterAuth]][BetterAuth-url]
|
- [![BetterAuth][BetterAuth]][BetterAuth-url]
|
||||||
|
- [![Docker][Docker]][Docker-url]
|
||||||
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -113,14 +115,14 @@ volumes:
|
|||||||
portabase-private:
|
portabase-private:
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
Then run:
|
Then run:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker compose up -d
|
docker compose up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
If you use reverse proxy like Traefik : [Check this link](https://portabase.io/docs/portabase/advanced-topics/reverse-proxy)
|
If you use reverse proxy like
|
||||||
|
Traefik : [Check this link](https://portabase.io/docs/portabase/advanced-topics/reverse-proxy)
|
||||||
|
|
||||||
### Option 2: Locally (Development)
|
### Option 2: Locally (Development)
|
||||||
|
|
||||||
@@ -133,6 +135,7 @@ If you use reverse proxy like Traefik : [Check this link](https://portabase.io/d
|
|||||||
```bash
|
```bash
|
||||||
docker compose up
|
docker compose up
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 🛠️ Usage
|
## 🛠️ Usage
|
||||||
@@ -147,11 +150,13 @@ It currently supports:
|
|||||||
|
|
||||||
1. **Access the dashboard** – Open `http://localhost:8887` in your browser.
|
1. **Access the dashboard** – Open `http://localhost:8887` in your browser.
|
||||||
2. **Sign up** – Register the first user, who will automatically have the **Admin** role in the default workspace.
|
2. **Sign up** – Register the first user, who will automatically have the **Admin** role in the default workspace.
|
||||||
3. **Add your first agent** – Follow [this guide](https://github.com/Soluce-Technologies/agent-portabase) for setup instructions.
|
3. **Add your first agent** – Follow [this guide](https://github.com/Soluce-Technologies/agent-portabase) for setup
|
||||||
|
instructions.
|
||||||
4. **Create organizations and projects** – Link your databases to projects to enable backups and restores.
|
4. **Create organizations and projects** – Link your databases to projects to enable backups and restores.
|
||||||
5. **Configure backup policies** – Define schedules (hourly, daily, weekly, or monthly) and retention rules.
|
5. **Configure backup policies** – Define schedules (hourly, daily, weekly, or monthly) and retention rules.
|
||||||
6. **Choose a storage provider** – Select where backups will be stored (local, S3, etc.).
|
6. **Choose a storage provider** – Select where backups will be stored (local, S3, etc.).
|
||||||
7. **Save and start** – Portabase validates your configuration and starts automated backups based on your defined policies.
|
7. **Save and start** – Portabase validates your configuration and starts automated backups based on your defined
|
||||||
|
policies.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -172,7 +177,6 @@ It currently supports:
|
|||||||
- [x] MySQL
|
- [x] MySQL
|
||||||
- [x] MariaDB
|
- [x] MariaDB
|
||||||
|
|
||||||
|
|
||||||
Check out [open issues](https://github.com/Soluce-Technologies/portabase/issues) for more.
|
Check out [open issues](https://github.com/Soluce-Technologies/portabase/issues) for more.
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -248,7 +252,8 @@ STORAGE_TYPE=local
|
|||||||
RETENTION_CRON="* * * * *"
|
RETENTION_CRON="* * * * *"
|
||||||
```
|
```
|
||||||
|
|
||||||
To get more information about env variables, check that [link](https://portabase.io/docs/portabase/advanced-topics/environment)
|
To get more information about env variables, check
|
||||||
|
that [link](https://portabase.io/docs/portabase/advanced-topics/environment)
|
||||||
|
|
||||||
### Semantic Versioning
|
### Semantic Versioning
|
||||||
|
|
||||||
@@ -282,12 +287,22 @@ Distributed under the Apache License. See `LICENSE.txt` for more details.
|
|||||||
|
|
||||||
Thanks to all contributors and the open-source community!
|
Thanks to all contributors and the open-source community!
|
||||||
|
|
||||||
|
[Docker]: https://img.shields.io/badge/Docker-2496ED?logo=docker&logoColor=fff&style=for-the-badge
|
||||||
|
|
||||||
[NextJS]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
|
[NextJS]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
|
||||||
|
|
||||||
[BetterAuth]: https://img.shields.io/badge/Better%20Auth-FFF?logo=betterauth&logoColor=000&style=for-the-badge
|
[BetterAuth]: https://img.shields.io/badge/Better%20Auth-FFF?logo=betterauth&logoColor=000&style=for-the-badge
|
||||||
|
|
||||||
[Drizzle]: https://img.shields.io/badge/Drizzle-111?style=for-the-badge&logo=Drizzle&logoColor=c5f74f
|
[Drizzle]: https://img.shields.io/badge/Drizzle-111?style=for-the-badge&logo=Drizzle&logoColor=c5f74f
|
||||||
|
|
||||||
[ShadcnUI]: https://img.shields.io/badge/shadcn/ui-000000?style=for-the-badge&logo=shadcn/ui&logoColor=white
|
[ShadcnUI]: https://img.shields.io/badge/shadcn/ui-000000?style=for-the-badge&logo=shadcn/ui&logoColor=white
|
||||||
|
|
||||||
[NextJS-url]: https://nextjs.org/
|
[NextJS-url]: https://nextjs.org/
|
||||||
|
|
||||||
[BetterAuth-url]: https://www.better-auth.com/
|
[BetterAuth-url]: https://www.better-auth.com/
|
||||||
|
|
||||||
[Drizzle-url]: https://orm.drizzle.team/
|
[Drizzle-url]: https://orm.drizzle.team/
|
||||||
|
|
||||||
[ShadcnUI-url]: https://ui.shadcn.com/
|
[ShadcnUI-url]: https://ui.shadcn.com/
|
||||||
|
[Docker-url]: https://www.docker.com/
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user