### Start OrcaCD Hub and Agent

Source: https://orcacd.dev/docs/setup/installation

After configuring the .env file, use docker compose to start the OrcaCD Hub and Agent services in detached mode.

```bash
docker compose up -d
```

--------------------------------

### Password Reset Confirmation Example

Source: https://orcacd.dev/docs/troubleshooting/account-recovery

This is an example of the confirmation message displayed after a successful password reset. It includes the user ID, email, and a new temporary password. The user is reminded to change this password on their next login.

```text
╭────────────────────────────────────────────────────────────────────╮
│                                                                    │
│ Password Reset Successful                                          │
│                                                                    │
│ User ID: 019dc111-5220-77bc-9729-2335f88fa658                      │
│ Email: test@orcacd.dev                                             │
│ New temporary password: w&BU6G,WM#!MX9M4eq                         │
│                                                                    │
│ Important: The user must change this password on the next login.   │
│                                                                    │
╰────────────────────────────────────────────────────────────────────╯
```

--------------------------------

### Conventional Commits Specification Example

Source: https://orcacd.dev/docs/helping-out/contributing

Follow the Conventional Commits specification for pull request naming. This format helps in organizing and automating the release process.

```bash
fix: hide global audit log switch for non admin users
```

--------------------------------

### TSR Router Initialization

Source: https://orcacd.dev/docs/helping-out/documentation

Initializes the TSR router with manifest and route data. This is part of the client-side routing setup.

```javascript
(self.$R=self.$R||{})["tsr"]= [];self.$_TSR={h(){this.hydrated=!0,this.c()},e(){this.streamEnded=!0,this.c()},c(){this.hydrated&&this.streamEnded&&(delete self.$_TSR,delete self.$R.tsr)},p(e){this.initialized?e():this.buffer.push(e)},buffer:[]};$_TSR.router=($R=>$R[0]={manifest:$R[1]={routes:$R[2]={__root__:$R[3]={preloads:$R[4]=["/assets/index-FTzOpV28.js"],assets:$R[5]=[$R[6]={tag:"link",attrs:$R[7]={rel:"stylesheet",href:"/assets/index-COnb255F.css",type:"text/css"}},$R[8]={tag:"script",attrs:$R[9]={type:"module",async:!0},children:"import(\"/assets/index-FTzOpV28.js\")"}}}},"/docs/$":$R[10]={preloads:$R[11]=["/assets/_-DXpQvX_d.js"]}}},matches:$R[12]=[$R[13]={i:"__root__�",u:1779611712711,s:"success",ssr:!0},$R[14]={i:"�docs�$�docs�helping-out�documentation",u:1779611712752,s:"success",l:$R[15]={path:"helping-out/documentation.mdx",markdownUrl:"/llms.mdx/docs/helping-out/documentation/content.md",pageTree:$R[16]={$fumadocs_loader:"page-tree",data:$R[17]={type:"root",$ref:"meta.json",$id:"root",name:"Getting Started",description:"The docs framework",children:$R[18]=[$R[19]={$id:"_0",type:"separator",icon:void 0,name:"Getting Started"},$R[20]={$id:"index.mdx",type:"page",name:"Introduction",description:"Welcome to OrcaCD - A simple service for using gitops with docker",icon:void 0,url:"/docs",$ref:"index.mdx"},$R[21]={$id:"demo.mdx",type:"page",name:"Demo",description:"Live demo of Orca CD in action, showcasing its features and capabilities.",icon:void 0,url:"/docs/demo",$ref:"demo.mdx"},$R[22]={$id:"architecture.mdx",type:"page",name:"Architecture",description:"An overview of the architecture of OrcaCD.",icon:void 0,url:"/docs/architecture",$ref:"architecture.mdx"},$R[23]={$id:"_1",type:"separator",icon:"<svg xmlns=\"http://www.w3.org/2000/svg\
```

--------------------------------

### Download Docker Compose and Environment Files

Source: https://orcacd.dev/docs/setup/installation

Use curl or wget to download the docker-compose.yml and .env.example files. These files are essential for setting up OrcaCD with Docker.

```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
```

--------------------------------

### Initialize OrcaCD

Source: https://orcacd.dev/docs/setup/installation

This snippet initializes OrcaCD. It should be placed in your main application file.

```javascript
import("/assets/index-FTzOpV28.js")
```

--------------------------------

### Backup OrcaCD Database

Source: https://orcacd.dev/docs/setup/upgrading

Run this command to create a backup of your OrcaCD database. Ensure the backup file is stored securely as part of your backup strategy.

```bash
docker compose exec hub /app/hub backup
```

--------------------------------

### Upgrade OrcaCD with Docker

Source: https://orcacd.dev/docs/setup/upgrading

Use these commands to pull the latest OrcaCD Docker image and restart the services to apply the upgrade. This is the recommended method for upgrading when using Docker.

```bash
docker compose pull && docker compose up -d
```

--------------------------------

### Caddyfile Configuration for OrcaCD

Source: https://orcacd.dev/docs/guides/reverse-proxy

Set up Caddy to act as a reverse proxy for OrcaCD. This configuration forwards traffic from the specified domain to the OrcaCD Hub.

```caddy
orcacd.example.com {
  reverse_proxy 127.0.0.1:8080
}
```

--------------------------------

### Run OrcaCD Locally with Docker

Source: https://orcacd.dev/docs/helping-out/contributing

Use this command to run the full OrcaCD stack locally using Docker Compose. The hub service will be available at http://localhost:8080.

```bash
docker compose -f docker-compose.dev.yaml up --build
```

--------------------------------

### Reset User Password with Docker Compose

Source: https://orcacd.dev/docs/troubleshooting/account-recovery

Execute the password reset command within a Dockerized OrcaCD environment. This command ensures the reset operation runs in the correct container context.

```bash
docker compose exec hub /app/hub reset-password <user id or email>
```

--------------------------------

### Nginx Server Block for OrcaCD

Source: https://orcacd.dev/docs/guides/reverse-proxy

Configure Nginx to proxy requests to the OrcaCD Hub. Ensure the Hub is exposed only on localhost and Nginx forwards traffic from your public domain.

```nginx
server {
  listen 80;
  server_name orcacd.example.com;

  location / {
    proxy_pass http://127.0.0.1:8080;
    proxy_http_version 1.1;

    proxy_set_header X-Forwarded-Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header X-Forwarded-Port  $server_port;

    # Required for WebSocket connections.
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection $connection_upgrade;
  }
}
```

--------------------------------

### Traefik Labels for OrcaCD Docker Compose

Source: https://orcacd.dev/docs/guides/reverse-proxy

Configure Traefik using Docker labels to route traffic to the OrcaCD Hub service. This is suitable for containerized deployments.

```docker-compose
services:
  hub:
    image: ghcr.io/orcacd/hub:latest
    container_name: orca-hub
    ports:
      - "127.0.0.1:8080:8080"
    restart: unless-stopped
    env_file: .env
    labels: 
      - "traefik.enable=true"
      - "traefik.http.routers.orcacd.rule=Host(`orcacd.example.com`)"
    volumes:
      - ./data/hub:/app/data
```

--------------------------------

### Reset User Password via Terminal

Source: https://orcacd.dev/docs/troubleshooting/account-recovery

Use this command to reset a user's password via the terminal. Replace `<user id or email>` with the target user's ID or email address. The user will be prompted to change this temporary password upon their next login.

```bash
hub reset-password <user id or email>
```

--------------------------------

### Scroll Restoration Script

Source: https://orcacd.dev/docs/helping-out/documentation

This script handles scroll restoration for the page, restoring scroll positions based on session storage and handling hash-based scrolling.

```javascript
(function(i){let l;try{l=JSON.parse(sessionStorage.getItem(i.storageKey)||"{}")}catch(e){console.error(e);return}const c=i.key||window.history.state?.\_\_TSR_key,o=c?l[c]:void 0;let f=!1;if(o&&typeof o=="object")for(const e in o){const t=o[e];if(!t||typeof t!="object")continue;const r=t.scrollX,s=t.scrollY;if(!(!Number.isFinite(r)||!Number.isFinite(s))){if(e==="window")window.scrollTo({top:s,left:r}),f=!0;else if(e){let n;try{n=document.querySelector(e)}catch{continue}n&&(n.scrollLeft=r,n.scrollTop=s)}}}if(f)return;const w=window.location.hash.split("#",2)[1];if(w){const e=window.history.state?.\_\_hashScrollIntoViewOptions??!0;if(e){const t=document.getElementById(w);t&&t.scrollIntoView(e)}return}window.scrollTo({top:0,left:0})})({"storageKey":"tsr-scroll-restoration-v1\_3"});document.currentScript.remove()
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.