-
Notifications
You must be signed in to change notification settings - Fork 0
feat: Add initial documentation structure #11
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.
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
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
534247e
feat: Add initial documentation structure
alex289 f488ace
Merge branch 'main' into feature/documentation_structure
alex289 26abf63
feat: Improve docmuentation structure and design
alex289 c8ded58
fix: Unused import
alex289 790e76b
feat: npm audit fix
alex289 5e141f8
feat: Apply review suggestions
alex289 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| title: Security | ||
| description: Secure your OrcaCD deployment with hardening | ||
| --- | ||
|
|
||
| TODO: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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" | ||
| ] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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: | ||
|
|
||
| ```bash | ||
| docker compose pull | ||
| docker compose up -d | ||
| ``` | ||
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| title: Common Issues | ||
| description: Solutions to frequently encountered problems | ||
| --- | ||
|
|
||
| TODO |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.