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
6 changes: 6 additions & 0 deletions content/docs/advanced/security.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Security
description: Secure your OrcaCD deployment with hardening
---

TODO:
35 changes: 35 additions & 0 deletions content/docs/configuration/env-variables.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: Environment Variables
description: Complete reference for all OrcaCD configuration options
---

Below are all the environment variables supported by OrcaCD. These should be configured in your `.env` file.

Be cautious when modifying environment variables that are not recommended to change.

## General

These environment variables can be used in both the agent and the hub.

| Variable | Default Value | Recommended to change | Description |
| ----------- | ------------- | --------------------- | ---------------------------------------------------------- |
| `DEBUG` | `false` | no | Debug mode |
| `LOG_LEVEL` | `info ` | no | Log level. Options: trace, debug, info, warn, error, fatal |

## Hub

| Variable | Default Value | Recommended to change | Description |
| ------------------ | ------------- | --------------------- | ------------------------------------------------------------------------------------------ |
| `APP_URL` | `-` | yes (required) | The URL of the OrcaCD instance |
| `APP_SECRET` | `-` | yes (required) | Secret used for authentication and encryption. Generate one with `openssl rand -base64 42` |
| `HOST` | `0.0.0.0 ` | no | Host address |
| `PORT` | `8080 ` | no | Container port |
| `DisableLocalAuth` | `false ` | no | Disable password authentication. Useful when using SSO with OIDC |
| `TrustedProxies` | `- ` | no | Recommended if using a reverse proxy. Comma seperated list of network origins |

## Agent

| Variable | Default Value | Recommended to change | Description |
| ------------ | ------------- | --------------------- | ------------------------------------------------------------------------------------------- |
| `HUB_URL` | `-` | yes (required) | The URL of the Hub. Example: `https://example.com` |
| `AUTH_TOKEN` | `- ` | yes (required) | The authentication token of the agent. Register an agent in the hub frontend to retrieve it |
10 changes: 10 additions & 0 deletions content/docs/guides/oidc.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: OIDC Authentication
description: Learn how to use OIDC providers for auhentication in OrcaCD
---

TODO:

## Example (Pocket Id)

TODO
12 changes: 12 additions & 0 deletions content/docs/guides/reverse-proxy.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Reverse Proxy
description: Learn how to use a reverse proxy with OrcaCD
---

## Nginx

TODO

## Traefik

TODO
6 changes: 6 additions & 0 deletions content/docs/helping-out/contributing.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Contributing
description: Learn how to contribute to the OrcaCD project
---

TODO
6 changes: 6 additions & 0 deletions content/docs/helping-out/documentation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Documentation
description: Contribute to improving the OrcaCD website or documentation
---

TODO
29 changes: 29 additions & 0 deletions content/docs/helping-out/translating.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Translating
description: Help translate OrcaCD into your language
---

Help us make OrcaCD accessible in your language by contributing translations.

## Translation Guidelines

Use informal language for translations

## Getting Started

1. Visit our [Crowdin project page](https://crowdin.com/project/orca-cd).
2. Choose the language you wish to translate into.
3. Open the `en-US.json` source file.
4. Now you can start translating the strings.

## Adding a New Language

TODO: Add language request issue template here

Is your language missing from Crowdin? You can [request its addition](https://crowdin.com/project/orca-cd).

## Need Help?

TODO: Add localization discussion

Encountering issues while translating? Join the [Localization discussion](https://crowdin.com/project/orca-cd) to seek help and share experiences.
39 changes: 18 additions & 21 deletions content/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,31 +1,28 @@
---
title: Hello World
description: Your favourite docs framework.
icon: Rocket
title: Introduction
description: Welcome to OrcaCD - A simple service for using gitops with docker
---

Hey there! Fumadocs is the docs framework that also works on Tanstack Start!
<Callout title="Project state" type="warn">
OrcaCD is in early development and not yet production-ready. There are no stable releases. Expect
breaking changes at any time.
</Callout>

## Heading
import { HomeIcon } from "lucide-react";

Hello World!
TODO: About section (motivation, ...)

TODO: Image examples

<Cards>
<Card title="Learn more about Tanstack Start" href="https://tanstack.com/start" />
<Card title="Learn more about Fumadocs" href="https://fumadocs.dev" />
<Card href="/docs/setup/installation" title="Installation">
Quickstart installation
</Card>
<Card href="/docs/configuration/env-variables" title="Environment variables">
Learn more the configuration options.
</Card>
</Cards>

### CodeBlock

```ts
console.log("Hello World");
```

#### Table
## Useful Links

| Head | Description |
| ------------------------------- | ----------------------------------- |
| `hello` | Hello World |
| very **important** | Hey |
| _Surprisingly_ | Fumadocs |
| very long text that looks weird | hello world hello world hello world |
- [Installation](/docs/setup/installation)
21 changes: 21 additions & 0 deletions content/docs/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"title": "Getting Started",
"description": "The docs framework",
"root": true,
"pages": [
"---Getting Started---",
"index",
"---[Rocket]Setup---",
"...setup",
"---[Settings]Configuration---",
"...configuration",
"---[Book]Guides---",
"...guides",
"---[Pickaxe]Advanced---",
"...advanced",
"---[Bug]Troubleshooting---",
"...troubleshooting",
"---[HandHelping]Helping Out---",
"...helping-out"
]
}
19 changes: 19 additions & 0 deletions content/docs/setup/installation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Installation
description: Get OrcaCD running quickly with Docker installation
---

## Installation with Docker

1. Download the [`docker-compose.yml`](https://raw.githubusercontent.com/OrcaCD/orca-cd/main/docker-compose.yml) and [`.env`](https://raw.githubusercontent.com/OrcaCD/orca-cd/main/.env.example) file:

```bash
curl -o docker-compose.yml https://raw.githubusercontent.com/OrcaCD/orca-cd/main/docker-compose.yml
curl -o .env https://raw.githubusercontent.com/OrcaCD/orca-cd/main/.env.example
```

2. Edit the `.env` file so that it fits your needs. See the environment variables section for more information.

3. Run `docker compose up -d`

Create an admin account on `https://<your-app-url>/login`
17 changes: 17 additions & 0 deletions content/docs/setup/upgrading.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Upgrading
description: Keep your OrcaCD installation up to date
---

<Callout title="Before upgrading" type="warn">
Before upgrading OrcaCD in production, we strongly recommend creating a backup of your database
and keeping a copy of your current `.env` and `docker-compose.yml` files. This gives you a
rollback path if something goes wrong.
</Callout>

For upgrading OrcaCD when using Docker, you just need to pull the latest image and restart the services:
Comment thread
alex289 marked this conversation as resolved.

```bash
docker compose pull
docker compose up -d
```
12 changes: 0 additions & 12 deletions content/docs/test.mdx

This file was deleted.

6 changes: 6 additions & 0 deletions content/docs/troubleshooting/common-issues.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Common Issues
description: Solutions to frequently encountered problems
---

TODO
Loading