chore: Enhance documentation for E2E testing:
- Added clarity and structure to README files, including recent updates and getting started sections. - Improved manual verification documentation for CrowdSec authentication, emphasizing expected outputs and success criteria. - Updated debugging guide with detailed output examples and automatic trace capture information. - Refined best practices for E2E tests, focusing on efficient polling, locator strategies, and state management. - Documented triage report for DNS Provider feature tests, highlighting issues fixed and test results before and after improvements. - Revised E2E test writing guide to include when to use specific helper functions and patterns for better test reliability. - Enhanced troubleshooting documentation with clear resolutions for common issues, including timeout and token configuration problems. - Updated tests README to provide quick links and best practices for writing robust tests.
This commit is contained in:
20
README.md
20
README.md
@@ -94,6 +94,7 @@ services:
|
||||
retries: 3
|
||||
start_period: 40s
|
||||
```
|
||||
|
||||
> **Docker Socket Access:** Charon runs as a non-root user. If you mount the Docker socket for container discovery, the container needs permission to read it. Find your socket's group ID and add it to the compose file:
|
||||
>
|
||||
> ```bash
|
||||
@@ -107,26 +108,34 @@ services:
|
||||
> - "998"
|
||||
> ```
|
||||
|
||||
### 2️⃣ Generate encryption key:
|
||||
### 2️⃣ Generate encryption key
|
||||
|
||||
```bash
|
||||
openssl rand -base64 32
|
||||
```
|
||||
### 3️⃣ Start Charon:
|
||||
|
||||
### 3️⃣ Start Charon
|
||||
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
### 4️⃣ Access the dashboard:
|
||||
|
||||
### 4️⃣ Access the dashboard
|
||||
|
||||
Open your browser and navigate to `http://localhost:8080` to access the dashboard and create your admin account.
|
||||
|
||||
```code
|
||||
http://localhost:8080
|
||||
```
|
||||
### Getting Started:
|
||||
Full setup instructions and documentation are available at [https://wikid82.github.io/Charon/docs/getting-started.html](https://wikid82.github.io/Charon/docs/getting-started.html).
|
||||
|
||||
### Getting Started
|
||||
|
||||
Full setup instructions and documentation are available at [https://wikid82.github.io/Charon/docs/getting-started.html](https://wikid82.github.io/Charon/docs/getting-started.html).
|
||||
|
||||
--- ## ✨ Top 10 Features
|
||||
|
||||
### 🎯 **Point & Click Management**
|
||||
|
||||
No config files. No terminal commands. Just click, type your domain name, and you're live. If you can use a website, you can run Charon.
|
||||
|
||||
### 🔐 **Automatic HTTPS Certificates**
|
||||
@@ -160,6 +169,7 @@ See exactly what's happening with live request logs, uptime monitoring, and inst
|
||||
### 📥 **Migration Made Easy**
|
||||
|
||||
Already invested in another reverse proxy? Bring your work with you by importing your existing configurations with one click:
|
||||
|
||||
- **Caddyfile** — Migrate from other Caddy setups
|
||||
- **Nginx** — Import from Nginx based configurations (Coming Soon)
|
||||
- **Traefik** - Import from Traefik based configurations (Coming Soon)
|
||||
|
||||
Reference in New Issue
Block a user