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
21 changes: 0 additions & 21 deletions .github/workflows/ci-and-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -268,27 +268,6 @@ jobs:
# Reuse existing gh-pages history when available so mike can maintain version metadata.
git fetch origin gh-pages:gh-pages || true

# One-time migration support: if old mike history exists at gh-pages root,
# copy it under /docs so /docs/versions.json keeps historical versions.
if git rev-parse --verify gh-pages >/dev/null 2>&1 \
&& git cat-file -e gh-pages:versions.json 2>/dev/null \
&& ! git cat-file -e gh-pages:docs/versions.json 2>/dev/null; then
git worktree add gh-pages-bootstrap gh-pages
mkdir -p gh-pages-bootstrap/docs
mapfile -t version_entries < <(jq -r '.[] | .version, (.aliases[]?)' gh-pages-bootstrap/versions.json | awk 'NF' | sort -u)
for entry in "${version_entries[@]}" versions.json index.html; do
if [ -e "gh-pages-bootstrap/$entry" ] || [ -L "gh-pages-bootstrap/$entry" ]; then
cp -a "gh-pages-bootstrap/$entry" gh-pages-bootstrap/docs/
fi
done

git -C gh-pages-bootstrap add docs
git -C gh-pages-bootstrap commit -m "Bootstrap docs prefix from existing mike history" || true
bootstrap_head=$(git -C gh-pages-bootstrap rev-parse HEAD)
git worktree remove gh-pages-bootstrap --force
git update-ref refs/heads/gh-pages "$bootstrap_head"
fi

mike deploy --branch gh-pages --deploy-prefix docs --alias-type copy --update-aliases main latest-dev
mike set-default --branch gh-pages --deploy-prefix docs main

Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Build Status](https://github.com/openwallet-foundation/eudiplo/actions/workflows/ci-and-release.yml/badge.svg)](https://github.com/openwallet-foundation/eudiplo/actions)
![License](https://img.shields.io/github/license/openwallet-foundation/eudiplo)
[![Website](https://img.shields.io/badge/website-eudiplo-blue)](https://openwallet-foundation.github.io/eudiplo/latest/)
[![Website](https://img.shields.io/badge/website-eudiplo-blue)](https://openwallet-foundation.github.io/eudiplo/docs/latest/)
[![Documentation Coverage](https://openwallet-foundation.github.io/eudiplo/main/compodoc/images/coverage-badge-documentation.svg)](https://openwallet-foundation.github.io/eudiplo/main/compodoc/coverage.html)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=openwallet-foundation_eudiplo&metric=coverage)](https://sonarcloud.io/project/overview?id=openwallet-foundation_eudiplo)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=openwallet-foundation_eudiplo&metric=security_rating)](https://sonarcloud.io/project/overview?id=openwallet-foundation_eudiplo)
Expand Down Expand Up @@ -158,10 +158,10 @@ curl -X POST http://localhost:3000/api/oauth2/token \
```

📚 API:
[https://openwallet-foundation.github.io/eudiplo/latest/api/](https://openwallet-foundation.github.io/eudiplo/latest/api/)
[https://openwallet-foundation.github.io/eudiplo/docs/latest/api/](https://openwallet-foundation.github.io/eudiplo/docs/latest/api/)
📦
Full setup:
[Quickstart Guide](https://openwallet-foundation.github.io/eudiplo/latest/getting-started/quick-start/)
[Quickstart Guide](https://openwallet-foundation.github.io/eudiplo/docs/latest/getting-started/quick-start/)

---

Expand All @@ -170,7 +170,7 @@ Full setup:
**Choose your documentation version:**

- 🚀 **Latest Stable** (recommended):
[https://openwallet-foundation.github.io/eudiplo/latest/](https://openwallet-foundation.github.io/eudiplo/latest/) -
[https://openwallet-foundation.github.io/eudiplo/docs/latest/](https://openwallet-foundation.github.io/eudiplo/docs/latest/) -
Documentation for the most recent major release
- 🔬 **Development**:
[https://openwallet-foundation.github.io/eudiplo/main/](https://openwallet-foundation.github.io/eudiplo/main/) -
Expand All @@ -181,10 +181,10 @@ Full setup:

**Key sections:**

- [Architecture](https://openwallet-foundation.github.io/eudiplo/latest/architecture/)
- [Supported Protocols](https://openwallet-foundation.github.io/eudiplo/latest/architecture/supported-protocols/)
- [API Reference](https://openwallet-foundation.github.io/eudiplo/latest/api/)
- [Code Documentation](https://openwallet-foundation.github.io/eudiplo/latest/compodoc/)
- [Architecture](https://openwallet-foundation.github.io/eudiplo/docs/latest/architecture/)
- [Supported Protocols](https://openwallet-foundation.github.io/eudiplo/docs/latest/architecture/supported-protocols/)
- [API Reference](https://openwallet-foundation.github.io/eudiplo/docs/latest/api/)
- [Code Documentation](https://openwallet-foundation.github.io/eudiplo/docs/latest/compodoc/)

---

Expand All @@ -207,4 +207,4 @@ Licensed under the [Apache 2.0 License](LICENSE)

## Governance

The Project Charter for EUDIPLO can be found [here](https://github.com/openwallet-foundation/technical-project-charters/blob/main/EUDIPLO%20Technical%20Charter%20(FINAL%2008.11.25).pdf).
The Project Charter for EUDIPLO can be found [here](<https://github.com/openwallet-foundation/technical-project-charters/blob/main/EUDIPLO%20Technical%20Charter%20(FINAL%2008.11.25).pdf>).
2 changes: 1 addition & 1 deletion apps/backend/src/auth/auth.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ export class AuthService {
scopes_supported: ["openid"],
claims_supported: ["iss", "sub", "aud", "exp", "iat"],
service_documentation:
"https://openwallet-foundation.github.io/eudiplo/latest/",
"https://openwallet-foundation.github.io/eudiplo/docs/latest/",
};
}
}
2 changes: 1 addition & 1 deletion apps/backend/src/core/app/app.controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export class AppController {
return {
service: "EUDIPLO",
documentation:
"https://openwallet-foundation.github.io/eudiplo/latest/",
"https://openwallet-foundation.github.io/eudiplo/docs/latest/",
};
}

Expand Down
6 changes: 3 additions & 3 deletions apps/backend/src/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ async function bootstrap() {
)
.setExternalDoc(
"Documentation",
"https://openwallet-foundation.github.io/eudiplo/latest/",
"https://openwallet-foundation.github.io/eudiplo/docs/latest/",
)
.setOpenAPIVersion("3.1.0")
.setVersion(process.env.VERSION ?? "main");
Expand Down Expand Up @@ -199,7 +199,7 @@ async function bootstrap() {
)
.setExternalDoc(
"Documentation",
"https://openwallet-foundation.github.io/eudiplo/latest/",
"https://openwallet-foundation.github.io/eudiplo/docs/latest/",
)
.setOpenAPIVersion("3.1.0")
.setVersion(process.env.VERSION ?? "main")
Expand Down Expand Up @@ -307,7 +307,7 @@ async function bootstrap() {
logger.log(` → Management: ${baseUrl}/api/docs`);
logger.log(` → Protocol: ${baseUrl}/docs`);
logger.log(
` → Full Docs: https://openwallet-foundation.github.io/eudiplo/latest/`,
` → Full Docs: https://openwallet-foundation.github.io/eudiplo/docs/latest/`,
);
logger.log("");
logger.log("🏥 Health Check:");
Expand Down
2 changes: 1 addition & 1 deletion apps/client/src/app/dashboard/dashboard.component.html
Original file line number Diff line number Diff line change
Expand Up @@ -578,7 +578,7 @@ <h3 class="track-title">
<div class="resource-links" fxLayout="row wrap" fxLayoutGap="16px">
<a
mat-stroked-button
href="https://openwallet-foundation.github.io/eudiplo/latest/"
href="https://openwallet-foundation.github.io/eudiplo/docs/latest/"
target="_blank"
rel="noopener"
>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ <h2>Create client</h2>
<mat-hint>
Select one or more roles.
<a
href="https://openwallet-foundation.github.io/eudiplo/latest/api/authentication/#protected-endpoints"
href="https://openwallet-foundation.github.io/eudiplo/docs/latest/api/authentication/#protected-endpoints"
target="_blank"
rel="noopener"
>Learn about roles</a
Expand Down
10 changes: 5 additions & 5 deletions deployment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This directory contains deployment configurations for EUDIPLO with multiple profiles to match your infrastructure needs.

**📖 For comprehensive deployment documentation, visit:**
**[https://openwallet-foundation.github.io/eudiplo/latest/deployment/](https://openwallet-foundation.github.io/eudiplo/latest/deployment/)**
**[https://openwallet-foundation.github.io/eudiplo/docs/latest/deployment/](https://openwallet-foundation.github.io/eudiplo/docs/latest/deployment/)**

## Deployment Options

Expand Down Expand Up @@ -66,9 +66,9 @@ deployment/

| Deployment | Path | Documentation | Use Case |
| ------------------ | ----------------------- | -------------------------------------------------------------------------------------------------------------- | ------------- |
| **Quick Start** | `../docker-compose.yml` | [Docker Compose Guide](https://openwallet-foundation.github.io/eudiplo/latest/deployment/docker-compose/) | Quick testing |
| **Docker Compose** | `docker-compose/` | [Docker Compose Guide](https://openwallet-foundation.github.io/eudiplo/latest/deployment/docker-compose/) | Development |
| **Kubernetes** | `k8s/` | [Kubernetes Guide](https://openwallet-foundation.github.io/eudiplo/latest/deployment/kubernetes/) | Production |
| **Quick Start** | `../docker-compose.yml` | [Docker Compose Guide](https://openwallet-foundation.github.io/eudiplo/docs/latest/deployment/docker-compose/) | Quick testing |
| **Docker Compose** | `docker-compose/` | [Docker Compose Guide](https://openwallet-foundation.github.io/eudiplo/docs/latest/deployment/docker-compose/) | Development |
| **Kubernetes** | `k8s/` | [Kubernetes Guide](https://openwallet-foundation.github.io/eudiplo/docs/latest/deployment/kubernetes/) | Production |

## Service Access

Expand All @@ -84,6 +84,6 @@ After deployment, access the services at:

## Support

- **Documentation:** [https://openwallet-foundation.github.io/eudiplo/latest/](https://openwallet-foundation.github.io/eudiplo/latest/)
- **Documentation:** [https://openwallet-foundation.github.io/eudiplo/docs/latest/](https://openwallet-foundation.github.io/eudiplo/docs/latest/)
- **Issues:** [GitHub Issues](https://github.com/openwallet-foundation/eudiplo/issues)
- **Community:** [Discord](https://discord.gg/58ys8XfXDu)
4 changes: 2 additions & 2 deletions deployment/docker-compose/.env.full.example
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ MINIO_ROOT_PASSWORD=changeme-strong-password
# =============================================================================
# Telemetry (optional)
# Enable OpenTelemetry export to a collector for metrics, traces, and logs.
# See: https://openwallet-foundation.github.io/eudiplo/latest/getting-started/monitor/
# See: https://openwallet-foundation.github.io/eudiplo/docs/latest/getting-started/monitor/
# =============================================================================
# OTEL_EXPORTER_OTLP_ENDPOINT=http://otel-collector:4318
# OTEL_SDK_DISABLED=false
Expand All @@ -122,7 +122,7 @@ MINIO_ROOT_PASSWORD=changeme-strong-password
# =============================================================================
# Client: Subpath Configuration (optional)
# Uncomment to serve the client from a reverse proxy subpath.
# See: https://openwallet-foundation.github.io/eudiplo/latest/deployment/tls/#serving-the-client-from-a-subpath
# See: https://openwallet-foundation.github.io/eudiplo/docs/latest/deployment/tls/#serving-the-client-from-a-subpath
# =============================================================================
# CLIENT_BASE_HREF=/eudiplo-client/

Expand Down
2 changes: 1 addition & 1 deletion deployment/docker-compose/.env.minimal.example
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,6 @@ LOCAL_STORAGE_DIR=/app/uploads
# =============================================================================
# Client: Subpath Configuration (optional)
# Uncomment to serve the client from a reverse proxy subpath.
# See: https://openwallet-foundation.github.io/eudiplo/latest/deployment/tls/#serving-the-client-from-a-subpath
# See: https://openwallet-foundation.github.io/eudiplo/docs/latest/deployment/tls/#serving-the-client-from-a-subpath
# =============================================================================
# CLIENT_BASE_HREF=/eudiplo-client/
4 changes: 2 additions & 2 deletions deployment/docker-compose/.env.standard.example
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ MINIO_ROOT_PASSWORD=minioadmin
# =============================================================================
# Telemetry (optional)
# Enable OpenTelemetry export to a collector for metrics, traces, and logs.
# See: https://openwallet-foundation.github.io/eudiplo/latest/getting-started/monitor/
# See: https://openwallet-foundation.github.io/eudiplo/docs/latest/getting-started/monitor/
# =============================================================================
# OTEL_EXPORTER_OTLP_ENDPOINT=http://otel-collector:4318
# OTEL_SDK_DISABLED=false
Expand All @@ -111,6 +111,6 @@ MINIO_ROOT_PASSWORD=minioadmin
# =============================================================================
# Client: Subpath Configuration (optional)
# Uncomment to serve the client from a reverse proxy subpath.
# See: https://openwallet-foundation.github.io/eudiplo/latest/deployment/tls/#serving-the-client-from-a-subpath
# See: https://openwallet-foundation.github.io/eudiplo/docs/latest/deployment/tls/#serving-the-client-from-a-subpath
# =============================================================================
# CLIENT_BASE_HREF=/eudiplo-client/
8 changes: 4 additions & 4 deletions deployment/docker-compose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@ docker compose --profile full up -d # Full
By default, EUDIPLO mounts `/app/config` from a named Docker volume.

- Default behavior (persistent named volume):
- `EUDIPLO_CONFIG_MOUNT` unset
- Compose uses `eudiplo-config:/app/config`
- `EUDIPLO_CONFIG_MOUNT` unset
- Compose uses `eudiplo-config:/app/config`
- Use repository config files (useful for load tests and config import):
- Set `EUDIPLO_CONFIG_MOUNT=../../assets:/app/config`
- Set `EUDIPLO_CONFIG_MOUNT=../../assets:/app/config`

When using the demo image (`EUDIPLO_IMAGE=ghcr.io/openwallet-foundation/eudiplo-demo:main` or `EUDIPLO_IMAGE=eudiplo-demo:local`), you typically do not need a bind mount for config import.

Expand Down Expand Up @@ -161,4 +161,4 @@ After deployment, access the services at:
4. **Set up TLS/HTTPS** via reverse proxy
5. **Configure backup strategies** for PostgreSQL and MinIO

For more details, see the [full documentation](https://openwallet-foundation.github.io/eudiplo/latest/deployment/docker-compose/).
For more details, see the [full documentation](https://openwallet-foundation.github.io/eudiplo/docs/latest/deployment/docker-compose/).
2 changes: 1 addition & 1 deletion deployment/docker-compose/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# docker compose --profile full up # Full: + Postgres + MinIO + Vault
#
# For more information, see the documentation:
# https://openwallet-foundation.github.io/eudiplo/latest/deployment/docker-compose/
# https://openwallet-foundation.github.io/eudiplo/docs/latest/deployment/docker-compose/

services:
# =============================================================================
Expand Down
4 changes: 2 additions & 2 deletions deployment/k8s/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This directory contains Kubernetes manifests for EUDIPLO using Kustomize for flexible, composable deployments.

📚 **Full documentation:** [https://openwallet-foundation.github.io/eudiplo/latest/deployment/kubernetes/](https://openwallet-foundation.github.io/eudiplo/latest/deployment/kubernetes/)
📚 **Full documentation:** [https://openwallet-foundation.github.io/eudiplo/docs/latest/deployment/kubernetes/](https://openwallet-foundation.github.io/eudiplo/docs/latest/deployment/kubernetes/)

## Directory Structure

Expand Down Expand Up @@ -148,4 +148,4 @@ kubectl -n eudiplo port-forward svc/eudiplo 3000:3000
4. **Configure resource limits**
5. **Set up monitoring** (Prometheus, Grafana)

👉 **[Read the full documentation](https://openwallet-foundation.github.io/eudiplo/latest/deployment/kubernetes/)**
👉 **[Read the full documentation](https://openwallet-foundation.github.io/eudiplo/docs/latest/deployment/kubernetes/)**
13 changes: 8 additions & 5 deletions website/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -824,7 +824,9 @@
<a href="#why">Why EUDIPLO</a>
<a href="#capabilities">Capabilities</a>
<a href="#docs-jump">Developer docs</a>
<a href="docs/" target="_blank" rel="noopener noreferrer">Docs</a>
<a href="docs/main/" target="_blank" rel="noopener noreferrer"
>Docs</a
>
<a
href="https://github.com/openwallet-foundation/eudiplo"
target="_blank"
Expand Down Expand Up @@ -929,7 +931,7 @@ <h3 class="quick-link-title">Getting Started</h3>
</a>
<a
class="quick-link"
href="docs/architecture/"
href="docs/main/architecture/"
target="_blank"
rel="noopener noreferrer"
>
Expand All @@ -942,7 +944,7 @@ <h3 class="quick-link-title">Architecture</h3>
</a>
<a
class="quick-link"
href="docs/api/"
href="docs/main/api/"
target="_blank"
rel="noopener noreferrer"
>
Expand All @@ -955,7 +957,7 @@ <h3 class="quick-link-title">API Reference</h3>
</a>
<a
class="quick-link"
href="docs/deployment/"
href="docs/main/deployment/"
target="_blank"
rel="noopener noreferrer"
>
Expand Down Expand Up @@ -1203,7 +1205,8 @@ <h2>Let your product focus on<br />what makes it different.</h2>
><img src="logo.svg" alt="" />eudiplo · An OpenWallet Foundation
project</span
><span class="footer-links"
><a href="docs/" target="_blank" rel="noopener noreferrer">Docs</a
><a href="docs/main/" target="_blank" rel="noopener noreferrer"
>Docs</a
><a
href="https://github.com/openwallet-foundation/eudiplo"
target="_blank"
Expand Down