github-personal/step-ca-webui
1
0
Fork 0
mirror of https://github.com/outbackdingo/step-ca-webui.git synced 2026-01-27 10:20:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

readme file list fix and other cleanup, front files moved to subdir

Browse Source
This commit is contained in:
stone-24tch3r
2024-09-26 23:41:57 +05:00
parent cd3e5f431b
commit a9f8a44920
8 changed files with 30 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
README.md
View File

@@ -69,9 +69,6 @@ All on one page
Diagram describes general architecture of the application. [Source PUML code](docs/architecture-overview.puml)
![architecture overview](https://plantuml.com/plantuml/svg/5Sqx3WCX30RXFgT83W0kaYhLNeKrLa3YWSplvVfXgz5NpJ4H55RBuvKR5ujYMfu96FDBf67vNqQoqwOezmPfyDmhJVGcRdt0wQrRCXm7j-IqJ3LiAyNEau9ooX26gRX-YLvPbX_ty90MT_y0)
### UI Mockup
See [docs/ui-mockups.md](docs/ui-mockups.md) for ASCII mockups of the UI.
### Logging
Convenient logging allows system to be transparent about underlying CLI wrapping.
This is important due to unstable nature of CLI tools.
@@ -97,38 +94,38 @@ project_root/
│
├── docker-compose.yml
├── README.md
│
├── docs/
│ ├── class-diagram.puml
│ ├── core-api.yaml
│ ├── architecture-overview.puml
│ └── ui-mockups.md
├── shared/
│ ├── __init__.py
│ ├── cli_wrapper.py
│ ├── logger.py
│ └── models.py
│
├── web_frontend/
│ ├── Dockerfile
│ ├── requirements.txt
│ ├── app.py
│ ├── api_client.py
│ ├── ui_components.py
│ └── templates/
│ ├── base.html
│ ├── dashboard.html
│ ├── logs.html
│ ├── certificate_management.html
│ └── modals/
│ └── generate_cert.html
├── requirements.txt
│
├── core/
│ ├── Dockerfile
│ ├── requirements.txt
│ ├── main.py
│ ├── api_server.py
│ └── certificate_manager.py
│ ├── certificate_manager.py
│ ├── Dockerfile
│ ├── main.py
│ └── requirements.txt
│
├── docs/
│ ├── architecture-overview.paml
│ ├── class-diagram.puml
│ └── core-api.yaml
│
├── front/
│ ├── api_client.py
│ ├── Dockerfile
│ ├── main.py
│ ├── requirements.txt
│ └── html/
│ ├── dashboard.html.j2
│ ├── logs.html.j2
│ ├── styles.css
│ └── script.js
│
├── shared/
│ ├── __init__.py
│ ├── api_models.py
│ ├── cli_wrapper.py
│ ├── db_logger.py
│ ├── logger.py
│ └── models.py
│
├── auto_setup/
│ ├── auto_setup.py

81
docs/ui-mockups.md
View File

@@ -1,81 +0,0 @@
# ASCII Mockups
Main page:
```
+--------------------------------------------+
| Logo [Dashboard] [Logs] [Menu] |
+--------------------------------------------+
| |
| Certificate Management |
| +--------------------------------------+ |
| | List of Certificates | |
| | +--------------------------------+ | |
| | | Cert Name | Status | Actions | | |
| | |-----------|---------|----------| | |
| | | Cert 1 | Active | [Renew] | | |
| | | | | [Revoke] | | |
| | |-----------|---------|----------| | |
| | | Cert 2 | Expired | [Delete] | | |
| | +--------------------------------+ | |
| | | |
| | [Generate New Certificate] | |
| +--------------------------------------+ |
+--------------------------------------------+
```
Generate cert modal dialog:
```
+------------------------------------------+
| Generate New certificate |
| +------------------------------------+ |
| | Key Name: __ | |
| | Key Type: >RSA | | #dropdown: RSA etc
| | Duration: ___ >days | | #dropdown: minutes, hours etc
| | | |
| | Command that will be executed: | |
| | [Click here to reload preview] | |
| | [Execute!] | | # if preview is loaded and all fields are filled
| | <$ step-ca command ... > | |
| | | |
| | Logs: <In progress...> | |
| | <Action-specific logs appear here> | |
| +------------------------------------+ |
+------------------------------------------+
```
Logs page:
```
+-----------------------------------------------------------------+
| Logo [Dashboard] [Logs] [Menu] |
+-----------------------------------------------------------------+
| |
| Logs and Command History |
| +-----------------------------------------------------------+ |
| | Filters: | |
| | Severity: [All v] Type: [All v] | |
| | Date Range: [From] [To] [Apply] | |
| | | |
| | Search: [____________] [Search] | |
| | | |
| | +-------------------------------------------------------+ | |
| | | EntryID | Timestamp | Severity | TraceID | Message | | |
| | |---------|-----------|----------|---------|------------| | |
| | | 00002 | 2023-08-1 | INFO | abc123 | Generating | | |
| | | | 7 10:15 | | | new cert | | |
| | | | $ step ca certificate ... | | |
| | | | [Click to see command output...] | | |
| | |---------|---------------------------------------------| | |
| | | 00003 | 2023-08-1 | WARN | def456 | Cert not | | |
| | | | 7 10:14 | | | exists | | |
| | |---------|--------------------------------|------------| | |
| | | 00004 | 2023-08-1 | DEBUG | def456 | Request | | |
| | | | 7 10:13 | | | revoke | | |
| | |---------|--------------------------------|------------| | |
| | | 00005 | 2023-08-1 | ERROR | ghi789 | Permission | | |
| | | | 7 10:12 | | | denied | | |
| | +-------------------------------------------------------+ | |
| | | |
| | [Load More] | |
| +-----------------------------------------------------------+ |
+-----------------------------------------------------------------+
```

0
front/main.html → front/html/dashboard.html
View File

0
front/logs.html → front/html/logs.html
View File

0
front/script.js → front/html/script.js
View File

0
front/styles.css → front/html/styles.css
View File

1
requirements.txt
View File

@@ -1,3 +1,4 @@
# dev
uvicorn~=0.30.6
fastapi~=0.112.1
pydantic~=2.8.2

0
shared/__init__.py Normal file
View File