moved documentation to look at the core-api openapi documentation.
This commit is contained in:
+1
-46
@@ -4,52 +4,7 @@ This directory contains version-controlled Docker Compose files for all services
|
||||
|
||||
## Deployment
|
||||
|
||||
### Via Portainer API (Recommended for Automation)
|
||||
|
||||
Use the `update-stack.sh` script to programmatically update stacks via Portainer's REST API:
|
||||
|
||||
```bash
|
||||
# Update a stack from YAML file
|
||||
cd stacks/
|
||||
./update-stack.sh open-webui.yml
|
||||
```
|
||||
|
||||
**First-time setup:**
|
||||
- Script will prompt for Portainer admin credentials
|
||||
- Generates and stores API token in `.portainer-token` (gitignored)
|
||||
- Subsequent runs use stored token automatically
|
||||
|
||||
**Non-interactive mode (for scripts/automation):**
|
||||
```bash
|
||||
export PORTAINER_USERNAME="admin"
|
||||
export PORTAINER_PASSWORD="your-password"
|
||||
./update-stack.sh open-webui.yml
|
||||
```
|
||||
|
||||
**Benefits:**
|
||||
- Safe for LLM agents and automation
|
||||
- No need for remote Portainer UI access
|
||||
- Version-controlled YAML files as source of truth
|
||||
- Automatic authentication and token management
|
||||
|
||||
### Via Portainer UI
|
||||
1. Navigate to **Stacks** → **Add Stack**
|
||||
2. Choose **Upload** and select the `.yml` file
|
||||
3. Review configuration and adjust environment variables
|
||||
4. Click **Deploy the stack**
|
||||
|
||||
### Via Docker CLI
|
||||
```bash
|
||||
# Deploy a stack
|
||||
docker compose -f stacks/<stack-name>.yml up -d
|
||||
|
||||
# Stop a stack
|
||||
docker compose -f stacks/<stack-name>.yml down
|
||||
|
||||
# Update a stack
|
||||
docker compose -f stacks/<stack-name>.yml pull
|
||||
docker compose -f stacks/<stack-name>.yml up -d
|
||||
```
|
||||
review the http://core-api/docs openapi documentation for infrastructure management REST endpoints.
|
||||
|
||||
## Stack Inventory
|
||||
|
||||
|
||||
Reference in New Issue
Block a user