Skip to content

Commit 77aaabe

Browse files
FEATURE (docs): Update readme and docs links
1 parent 01911db commit 77aaabe

File tree

9 files changed

+26
-204
lines changed

9 files changed

+26
-204
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,13 @@
4040
- **Precise timing**: run backups at specific times (e.g., 4 AM during low traffic)
4141
- **Smart compression**: 4-8x space savings with balanced compression (~20% overhead)
4242

43-
### 🗄️ **Multiple Storage Destinations**
43+
### 🗄️ **Multiple Storage Destinations** <a href="https://postgresus.com/storages">(docs)</a>
4444

4545
- **Local storage**: Keep backups on your VPS/server
4646
- **Cloud storage**: S3, Cloudflare R2, Google Drive, NAS, Dropbox and more
4747
- **Secure**: All data stays under your control
4848

49-
### 📱 **Smart Notifications**
49+
### 📱 **Smart Notifications** <a href="https://postgresus.com/notifiers">(docs)</a>
5050

5151
- **Multiple channels**: Email, Telegram, Slack, Discord, webhooks
5252
- **Real-time updates**: Success and failure notifications
@@ -58,13 +58,20 @@
5858
- **SSL support**: Secure connections available
5959
- **Easy restoration**: One-click restore from any backup
6060

61+
### 👥 **Suitable for Teams** <a href="https://postgresus.com/access-management">(docs)</a>
62+
63+
- **Workspaces**: Group databases, notifiers and storages for different projects or teams
64+
- **Access management**: Control who can view or manage specific databases with role-based permissions
65+
- **Audit logs**: Track all system activities and changes made by users
66+
- **User roles**: Assign viewer, member, admin or owner roles within workspaces
67+
6168
### 🐳 **Self-Hosted & Secure**
6269

6370
- **Docker-based**: Easy deployment and management
6471
- **Privacy-first**: All your data stays on your infrastructure
6572
- **Open source**: Apache 2.0 licensed, inspect every line of code
6673

67-
### 📦 Installation
74+
### 📦 Installation <a href="https://postgresus.com/installation">(docs)</a>
6875

6976
You have three ways to install Postgresus:
7077

@@ -118,8 +125,6 @@ This single command will:
118125
Create a `docker-compose.yml` file with the following configuration:
119126

120127
```yaml
121-
version: "3"
122-
123128
services:
124129
postgresus:
125130
container_name: postgresus
@@ -149,9 +154,9 @@ docker compose up -d
149154
6. **Add notifications** (optional): Configure email, Telegram, Slack, or webhook notifications
150155
7. **Save and start**: Postgresus will validate settings and begin the backup schedule
151156

152-
### 🔑 Resetting Admin Password
157+
### 🔑 Resetting Password <a href="https://postgresus.com/password">(docs)</a>
153158

154-
If you need to reset the admin password, you can use the built-in password reset command:
159+
If you need to reset the password, you can use the built-in password reset command:
155160

156161
```bash
157162
docker exec -it postgresus ./main --new-password="YourNewSecurePassword123" --email="admin"
@@ -169,4 +174,4 @@ This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENS
169174

170175
## 🤝 Contributing
171176

172-
Contributions are welcome! Read [contributing guide](contribute/README.md) for more details, prioerities and rules are specified there. If you want to contribute, but don't know what and how - message me on Telegram [@rostislav_dugin](https://t.me/rostislav_dugin)
177+
Contributions are welcome! Read <a href="https://postgresus.com/contributing">contributing guide</a> for more details, prioerities and rules are specified there. If you want to contribute, but don't know what and how - message me on Telegram [@rostislav_dugin](https://t.me/rostislav_dugin)

assets/logo.svg

Lines changed: 9 additions & 2 deletions
Loading

contribute/README.md

Lines changed: 0 additions & 94 deletions
This file was deleted.

contribute/how-to-add-notifier.md

Lines changed: 0 additions & 45 deletions
This file was deleted.

contribute/how-to-add-storage.md

Lines changed: 0 additions & 51 deletions
This file was deleted.

frontend/src/features/notifiers/ui/edit/notifiers/EditSlackNotifierComponent.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export function EditSlackNotifierComponent({ notifier, setNotifier, setIsUnsaved
1414
<div className="mb-1 ml-[130px] max-w-[200px]" style={{ lineHeight: 1 }}>
1515
<a
1616
className="text-xs !text-blue-600"
17-
href="https://postgresus.com/notifier-slack"
17+
href="https://postgresus.com/notifiers/slack"
1818
target="_blank"
1919
rel="noreferrer"
2020
>

frontend/src/features/notifiers/ui/edit/notifiers/EditTeamsNotifierComponent.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export function EditTeamsNotifierComponent({ notifier, setNotifier, setIsUnsaved
3030
<div className="mb-1 ml-[130px] max-w-[200px]" style={{ lineHeight: 1 }}>
3131
<a
3232
className="text-xs !text-blue-600"
33-
href="https://postgresus.com/notifier-teams"
33+
href="https://postgresus.com/notifiers/teams"
3434
target="_blank"
3535
rel="noreferrer"
3636
>

frontend/src/features/storages/ui/edit/storages/EditGoogleDriveStorageComponent.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export function EditGoogleDriveStorageComponent({ storage, setStorage, setIsUnsa
4040
<div className="min-w-[110px]" />
4141

4242
<div className="text-xs text-blue-600">
43-
<a href="https://postgresus.com/google-drive-storage" target="_blank" rel="noreferrer">
43+
<a href="https://postgresus.com/storages/google-drive" target="_blank" rel="noreferrer">
4444
How to connect Google Drive?
4545
</a>
4646
</div>

frontend/src/features/storages/ui/edit/storages/EditS3StorageComponent.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export function EditS3StorageComponent({ storage, setStorage, setIsUnsaved }: Pr
1616
<div className="min-w-[110px]" />
1717

1818
<div className="text-xs text-blue-600">
19-
<a href="https://postgresus.com/cloudflare-r2-storage" target="_blank" rel="noreferrer">
19+
<a href="https://postgresus.com/storages/cloudflare-r2" target="_blank" rel="noreferrer">
2020
How to use with Cloudflare R2?
2121
</a>
2222
</div>

0 commit comments

Comments
 (0)