Skip to content
Merged
Show file tree
Hide file tree
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
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,26 @@ Self-hosted secrets management with web UI and REST API.

## Screenshots

![Login](docs/screenshots/01-login.png)
*Clean login interface with dark mode*

![Secrets Dashboard](docs/screenshots/02-secrets-dashboard.png)
![Permissions](docs/screenshots/06-permissions.png)
*Main dashboard showing secrets management*

![Secret Revealed](docs/screenshots/03-secret-revealed.png)
*Viewing a secret value with one click*

![Users Panel](docs/screenshots/04-users-panel.png)
*User management interface*

![Tokens Panel](docs/screenshots/05-tokens-panel.png)
*API token management*

![Permissions Panel](docs/screenshots/06-permissions-panel.png)
*Permission configuration for tokens*

![Login with Cloudflare Turnstile](docs/screenshots/07-login-with-captcha.png)
*Login page with Cloudflare Turnstile captcha enabled*

## Installation

Expand Down
39 changes: 39 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Documentation

This directory contains documentation assets for the Secrets Manager project.

## Structure

```
docs/
├── README.md # This file
└── screenshots/ # Application screenshots for documentation
├── 01-login.png # Login page
├── 02-secrets-dashboard.png # Secrets management panel
├── 03-secret-revealed.png # Secret value revealed
├── 04-users-panel.png # User management panel
├── 05-tokens-panel.png # API token management panel
├── 06-permissions-panel.png # Permission configuration panel
└── 07-login-with-captcha.png # Login with Cloudflare Turnstile captcha
```

## Screenshots

All screenshots are taken at 1280x720 resolution in PNG format and show the application's dark mode interface.

### Adding New Screenshots

When updating screenshots:

1. Start the server: `go run cmd/secretsserver/main.go --admin-password "admin123"`
2. Navigate to `http://127.0.0.1:7770`
3. Capture screenshots of each panel
4. Save them with the naming convention: `##-descriptive-name.png`
5. Update the main README.md to reference new screenshots

### Screenshot Guidelines

- Use consistent viewport size (1280x720 or similar)
- Capture the full application interface including header and navigation
- Use realistic but safe example data (no real secrets)
- Ensure dark mode is enabled for consistency
Binary file added docs/screenshots/01-login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/02-secrets-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/03-secret-revealed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/04-users-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/05-tokens-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/screenshots/06-permissions-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/screenshots/06-permissions.png
Binary file not shown.
Binary file added docs/screenshots/07-login-with-captcha.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions web/.gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
node_modules/
dist/
yarn-error.log
tsconfig.tsbuildinfo
1 change: 0 additions & 1 deletion web/tsconfig.tsbuildinfo

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot why did u remove this?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tsconfig.tsbuildinfo is a TypeScript build artifact that gets regenerated on each build. It shouldn't be in version control as it's specific to each build environment. Added it to .gitignore in f05dca0.

This file was deleted.