Skip to content

fix(docs): tidying "Getting started" #166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
b-long merged 3 commits into from
Dec 22, 2025
Merged

fix(docs): tidying "Getting started" #166

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
482f7ee
fix(docs): update docker cp commands to use docker compose
b-long Dec 22, 2025
dfc4632
chore: move CSS to stylesheet
b-long Dec 22, 2025
4078379
chore: improve CSS slightly
b-long Dec 22, 2025
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
28 changes: 25 additions & 3 deletions docs/getting-started/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,28 @@ slug: /getting-started
import dockerComposeContent from '!!raw-loader!./docker-compose.yaml';
import CodeBlock from '@theme/CodeBlock';

<style>
{`
.download-button {
display: inline-block;
padding: 8px 16px;
background-color: #0066cc;
color: white;
text-decoration: none;
border-radius: 4px;
margin-bottom: 16px;
transition: all 0.2s ease;
}

.download-button:hover {
background-color: #0052a3;
box-shadow: 0 4px 8px rgba(0, 0, 0, 0.2);
color: white;
}

`}
</style>

# Getting Started

This guide will walk you through setting up a new platform locally and walk you through some of the basic concepts within the OpenTDF platform.
Expand Down Expand Up @@ -34,7 +56,7 @@ The first step is to get the platform running locally. You can use the following
Not for production use.
:::

<a href="/quickstart/docker-compose.yaml" download="docker-compose.yaml" style={{display: 'inline-block', padding: '8px 16px', backgroundColor: '#0066cc', color: 'white', textDecoration: 'none', borderRadius: '4px', marginBottom: '16px'}}>Download docker-compose.yaml</a>
<a href="/quickstart/docker-compose.yaml" download="docker-compose.yaml" className="download-button">Download docker-compose.yaml</a>

<details>
<summary>Docker Compose</summary>
Expand Down Expand Up @@ -73,11 +95,11 @@ mkdir -p ./opentdf-certs
```

```shell
docker cp opentdf-caddy-1:/data/caddy/certificates/local/keycloak.opentdf.local/keycloak.opentdf.local.crt ./opentdf-certs
docker compose cp caddy:/data/caddy/certificates/local/keycloak.opentdf.local/keycloak.opentdf.local.crt ./opentdf-certs
```

```shell
docker cp opentdf-caddy-1:/data/caddy/certificates/local/platform.opentdf.local/platform.opentdf.local.crt ./opentdf-certs
docker compose cp caddy:/data/caddy/certificates/local/platform.opentdf.local/platform.opentdf.local.crt ./opentdf-certs
```

### Import and Trust Certificates by Operating System
Expand Down