Skip to content

Commit 8463016

Browse files
committed
docs: reorganize documentation structure and update references to environment variables, added dashboard page
1 parent da9339b commit 8463016

26 files changed

Lines changed: 411 additions & 38 deletions

.env.dist

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Documentation available in docs/environment-variables.md
1+
# Documentation available in docs/configuration/environment-variables.md
22
#
33

44
# Database credentials

.mkdocs.yaml

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,27 +19,28 @@ nav:
1919
- installation.md
2020
- upgrade.md
2121
- Configuration:
22-
- environment-variables.md
23-
- dns-configuration.md
24-
- external-mysql.md
25-
- relayhost.md
26-
- local-address-extension.md
27-
- php-sessions.md
28-
- reverse-proxy.md
29-
- roundcube.md
30-
- tls.md
22+
- configuration/environment-variables.md
23+
- configuration/dns-configuration.md
24+
- configuration/external-mysql.md
25+
- configuration/relayhost.md
26+
- configuration/local-address-extension.md
27+
- configuration/php-sessions.md
28+
- configuration/reverse-proxy.md
29+
- configuration/roundcube.md
30+
- configuration/tls.md
3131
- Administration:
32-
- manage-domains.md
33-
- manage-users.md
34-
- manage-aliases.md
35-
- manage-fetchmail.md
36-
- dkim-signing.md
32+
- administration/dashboard.md
33+
- administration/manage-domains.md
34+
- administration/manage-users.md
35+
- administration/manage-aliases.md
36+
- administration/manage-fetchmail.md
37+
- administration/dkim-signing.md
3738
- Recipes:
3839
- Docker:
3940
- Traefik Reverse Proxy: https://github.com/jeboehm/docker-mailserver/tree/main/docs/example-configs/compose/traefik-reverse-proxy
4041
- Kubernetes:
4142
- External Database and HTTPS Ingress: https://github.com/jeboehm/docker-mailserver/tree/main/docs/example-configs/kustomize/external-db-and-https-ingress
4243
- Development:
43-
- architecture.md
44-
- development.md
44+
- development/architecture.md
45+
- development/development.md
4546
- Issues: https://github.com/jeboehm/docker-mailserver/issues

Pipfile

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[[source]]
2+
url = "https://pypi.org/simple"
3+
verify_ssl = true
4+
name = "pypi"
5+
6+
[packages]
7+
mkdocs = "==1.6.1"
8+
pygments = "==2.19.2"
9+
pymdown-extensions = "==10.19"
10+
11+
[dev-packages]
12+
13+
[requires]
14+
python_version = "3.14"

Pipfile.lock

Lines changed: 353 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,17 +43,18 @@ For detailed installation instructions, see the [Installation Guide](https://jeb
4343

4444
## Screenshots
4545

46-
### Manage users
46+
### Dashboard
4747

48-
![User overview](https://raw.githubusercontent.com/jeboehm/mailserver-admin/master/.github/screenshots/user.png)
48+
![Dashboard](docs/images/admin/dashboard.png)
4949

50-
### Manage aliases
50+
### User management
5151

52-
![Alias overview](https://raw.githubusercontent.com/jeboehm/mailserver-admin/master/.github/screenshots/alias.png)
52+
![User List](docs/images/admin/user_list.png)
53+
![User Edit](docs/images/admin/user_edit.png)
5354

5455
### DKIM setup
5556

56-
![DKIM setup](https://raw.githubusercontent.com/jeboehm/mailserver-admin/master/.github/screenshots/dkim_edit.png)
57+
![DKIM setup](docs/images/admin/dkim_edit.png)
5758

5859
## Links
5960

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The mailserver consists of multiple microservices:
4545
- **Unbound** - DNS resolver for the filter service
4646
- **Fetchmail** - External mail retrieval (optional)
4747

48-
See [Architecture Documentation](architecture.md) for detailed information.
48+
See [Architecture Documentation](development/architecture.md) for detailed information.
4949

5050
## Getting Help
5151

docs/administration/dashboard.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Dashboard
2+
3+
The dashboard is the main page of the administration tool. It provides a quick overview of the mailserver and the most important information.
4+
5+
![Dashboard](../images/admin/dashboard.png)
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Configure DKIM through the management interface:
2020
6. Verify the DNS record through the management interface
2121
7. Enable DKIM signing for the domain
2222

23-
![DKIM Edit](images/admin/dkim_edit.png)
23+
![DKIM Edit](../images/admin/dkim_edit.png)
2424

2525
## DNS Record
2626

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Email aliases provide flexible email routing without requiring separate user acc
3030
- **Destination Address(es)**: An email address to forward emails to
3131
5. Save the alias
3232

33-
![Alias Create](images/admin/alias_create.png)
33+
![Alias Create](../images/admin/alias_create.png)
3434

3535
The source address must belong to a domain that exists in the system. Destination addresses can be:
3636

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Domain management is restricted to users with **Admin** role. Domain administrat
1616

1717
The domain list shows all configured domains in the system:
1818

19-
![Domain List](images/admin/domain_list.png)
19+
![Domain List](../images/admin/domain_list.png)
2020

2121
### Adding a Domain
2222

0 commit comments

Comments
 (0)