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.

Sign up for GitHub

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

Document 2 #85

Merged
merged 2 commits into from
Sep 18, 2023
Merged

Document 2 #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1f12e9
📄 docs: update
maxisam Sep 18, 2023
96a6e45
🐞 fix: branch
maxisam Sep 18, 2023
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
2 changes: 1 addition & 1 deletion .github/workflows/sponsors.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ jobs:
- name: Deploy to GitHub Pages 🚀
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
branch: main
folder: "."
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ helm upgrade --install mgob maxisam/mgob --namespace mgob --create-namespace
- http file server for local backups and logs
- distributed as an Alpine Docker image

#### Install
## Installation

MGOB is available on Docker Hub at [maxisam/mgob](https://hub.docker.com/repository/docker/maxisam/mgob).

Expand Down Expand Up @@ -78,28 +78,28 @@ docker run -dp 8090:8090 --name mgob \
-LogLevel=info
```

#### Configure
## Configuration

Define a backup plan (yaml format) for each database you want to backup inside the `config` dir.
The yaml file name is being used as the backup plan ID, no white spaces or special characters are allowed.

[READ MORE](.document/BACKUP_PLAN.md)

#### On-Demand Operations
## On-Demand Operations

MGOB exposes a set of HTTP endpoints for on-demand operations like backup, restore, status, metrics, and version.

READ MORE: [On-Demand Operations](.document/ON_DEMAND_OPERATION.md)

#### Logs
## Logs

READ MORE: [Logs](.document/LOGS.md)

#### Metrics
## Metrics

READ MORE: [Metrics](.document/METRICS.md)

#### Restore
## Restore

READ MORE: [Restore](.document/RESTORE.md)

Expand Down