FaynoSync

https://faynosync.com/docs
Admin
FaynoSync is a comprehensive, powerful auto-updater service written in Golang that keeps...
Tokens:75,738
Snippets:646
Trust Score:5.4
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example Request to Get All Platforms

Source: https://faynosync.com/docs/api/platforms/get

Demonstrates how to make a GET request to the /platform/list endpoint, including the required Authorization header.

```curl
curl -X GET http://localhost:9000/platform/list \
-H "Authorization: Bearer <jwt_token>"
```

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

### FaynoSync Container Output Example

Source: https://faynosync.com/docs/getting-started/production-deploy

Example output from the FaynoSync container after starting, indicating successful connections to MongoDB and Redis, and completion of migrations.

```text
faynoSync_backend  | time="2025-09-17T11:19:18Z" level=info msg="Connected to MongoDB!"
faynoSync_backend  | time="2025-09-17T11:19:18Z" level=info msg="Migrations completed"
faynoSync_backend  | time="2025-09-17T11:19:18Z" level=info msg="Redis connection is required. Connecting to Redis."
faynoSync_backend  | time="2025-09-17T11:19:18Z" level=info msg="Connected to Redis successfully"

```

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

### List Applications Request Example

Source: https://faynosync.com/docs/api/apps/list-apps

Example of how to make a GET request to the /app/list endpoint using curl, including the required Authorization header.

```bash
curl -X GET http://localhost:9000/app/list -H "Authorization: Bearer <jwt_token>"
```

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

### Example Request using cURL

Source: https://faynosync.com/docs/api/archs/get

Demonstrates how to call the Get All Architectures endpoint using cURL, including the necessary authorization header.

```curl
curl -X GET http://localhost:9000/arch/list \
-H "Authorization: Bearer <jwt_token>"
```

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

### Start FaynoSync Server

Source: https://faynosync.com/docs/getting-started/local-development

Start the FaynoSync API server locally. Ensure all prerequisites and environment configurations are set up.

```bash
go run faynoSync.go  
```

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

### Run Dependency Services for Local Golang Development

Source: https://faynosync.com/docs/getting-started/docker-development

Start only the dependency services required for FaynoSync development when Golang is installed locally. This command starts essential services like MongoDB and local S3-compatible storage without running the full API in a container.

```bash
docker compose -f docker-compose.yaml -f docker-compose.development.yaml up  
```

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

### Example .env File Configuration

Source: https://faynosync.com/docs/getting-started/env-overview

A comprehensive example of a .env file demonstrating configurations for Minio, AWS S3, DigitalOcean Spaces, GCP, and other application settings.

```env
# =============================================================================
# MINIO (deprecated, kept for backward compatibility)
# =============================================================================
# STORAGE_DRIVER=minio
# MINIO_SECURE=false
S3_BUCKET_NAME_PRIVATE=cb-faynosync-s3-private
S3_ENDPOINT_PRIVATE=localhost:9010
S3_ACCESS_KEY=
S3_SECRET_KEY=
S3_BUCKET_NAME=cb-faynosync-s3-public
S3_ENDPOINT=localhost:9010

# =============================================================================
# AWS S3 (Amazon Simple Storage Service)
# =============================================================================
STORAGE_DRIVER=aws
#S3_ACCESS_KEY=
#S3_SECRET_KEY=
#S3_REGION=
# S3_BUCKET_NAME_PRIVATE=
# S3_BUCKET_NAME=
#S3_ENDPOINT_PRIVATE=https://<bucket_name>.s3.amazonaws.com # for example in us-east-1
#S3_ENDPOINT=https://<bucket_name>.s3.amazonaws.com # for example in us-east-1
#S3_API_ENDPOINT=http://localhost:3900 # optional for S3-compatible providers (Garage, etc.)
#S3_FORCE_PATH_STYLE=true # optional for providers that require path-style requests
#S3_DISABLE_OBJECT_ACL=true # optional for providers without public-read ACL support

# =============================================================================
# DIGITALOCEAN SPACES (S3-compatible storage from DigitalOcean)
# =============================================================================
# STORAGE_DRIVER=digitalocean
# S3_ENDPOINT_PRIVATE=nyc3.digitaloceanspaces.com
# S3_REGION=nyc3
# S3_ACCESS_KEY=DO00EXAMPLEKEY
# S3_SECRET_KEY=EXAMPLE_SECRET_KEY
# S3_BUCKET_NAME_PRIVATE=
# S3_BUCKET_NAME=

# =============================================================================
# GOOGLE CLOUD STORAGE (GCP)
# =============================================================================
# STORAGE_DRIVER=gcp
# GCS_CREDENTIALS_FILE=/path/to/credentials.json
# GCS_SERVICE_ACCOUNT_EMAIL=your-service-account@project.iam.gserviceaccount.com
# GCS_PRIVATE_KEY=-----BEGIN PRIVATE KEY-----
MIIEv...
-----END PRIVATE KEY-----
# S3_BUCKET_NAME_PRIVATE=
# S3_BUCKET_NAME=

# =============================================================================
# Other Configuration
# =============================================================================
DASHBOARD_URL=http://localhost:3000
PORT=9000
MONGODB_URL=mongodb://root:password@127.0.0.1/faynosync_db?authSource=admin
API_KEY=generated_api_key
API_URL=http://localhost:9000
ENABLE_PRIVATE_APP_DOWNLOADING=false
JWT_SECRET=your_jwt_secret
MONGODB_URL_TESTS=mongodb://root:password@127.0.0.1/faynosync_db_tests?authSource=admin
PERFORMANCE_MODE=true
REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_PASSWORD=
REDIS_DB=0
SLACK_ENABLE=false
SLACK_BOT_TOKEN=xoxb-*
SLACK_CHANNEL=test-channel
SLACK_NOTIFICATION_TTL=24h
ENABLE_TELEMETRY=true

# =============================================================================
# TUF (The Update Framework)
# =============================================================================
TUF_ENABLED=true
ONLINE_KEY_DIR=/private_keys

```

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

### Start FaynoSync Services

Source: https://faynosync.com/docs/getting-started/local-deploy

Run this command to start all necessary FaynoSync services in detached mode.

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

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

### Example Request to List Users

Source: https://faynosync.com/docs/api/team/list

This example shows how to make a GET request to the /users/list endpoint using curl. Authentication is handled via the Authorization header.

```curl
curl -X GET http://localhost:9000/users/list \
-H "Authorization: Bearer <jwt_token>"
```

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

### Example cURL Request

Source: https://faynosync.com/docs/api/channels/get

Demonstrates how to make a cURL request to the Get All Channels endpoint, including the necessary authorization header.

```bash
curl -X GET http://localhost:9000/channel/list -H "Authorization: Bearer <jwt_token>"
```

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

### Error Response (404 Not Found)

Source: https://faynosync.com/docs/api/tuf/get_config

Example JSON response when bootstrap has not been completed for the app or no repository configuration is found in Redis. This indicates that the 'Start Bootstrap' process needs to be run first.

```json
{
  "error": "It requires bootstrap. State: ",
  "message": "No Repository Settings/Config found."
}
```

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

### Example Platform Configuration

Source: https://faynosync.com/docs/updaters

Illustrates how to configure multiple updaters for a platform, including specifying a default updater. This configuration is applied at the platform level.

```json
{
  "id": "689f076f9ed9e38071926986",
  "platform": "darwin",
  "updaters": [
    { "type": "manual", "default": true },
    { "type": "squirrel_darwin", "default": false },
    { "type": "electron-builder" },
    { "type": "tauri" }
  ]
}

```

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

### Example Request to Get Unsigned Root Metadata

Source: https://faynosync.com/docs/api/tuf/get_unsigned_root_metadata

Example cURL command to retrieve unsigned root metadata. Replace <app_name> and <jwt_token> with your actual values.

```bash
curl --location 'http://localhost:9000/tuf/v1/metadata/sign?appName=<app_name>'
--header 'Authorization: Bearer <jwt_token>'
```

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

### Signup Request Example

Source: https://faynosync.com/docs/api/auth/signup

Example of a cURL request to the signup endpoint with JSON payload.

```curl
curl -X POST -H "Content-Type: application/json" \
-d '{"username": "admin", "password": "password", "api_key": "UHp3aKb40fwpoKZluZByWQ"}' \
http://localhost:9000/signup
```

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

### Install FaynoSync Admin Dashboard Dependencies

Source: https://faynosync.com/docs/getting-started/docker-development

Install all necessary dependencies for the FaynoSync Admin Dashboard using yarn.

```bash
yarn install  
```

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

### Success Response Example

Source: https://faynosync.com/docs/api/tokens/create

This is an example of a successful response when creating a token. The full token secret is returned only once and should be saved immediately.

```json
{
  "allowed_apps": [
    "69259667351f660c2fd62d39",
    "69259667351f660c2fd62d40"
  ],
  "created_at": "2026-02-20T16:39:16.233976+02:00",
  "expires_at": "2026-12-31T00:00:00Z",
  "id": "699872148c1ed923e48bc2c9",
  "name": "GitHub Actions - MyApp",
  "token": "fns_22ba5585a1d3d9e2c7c42d4339ab486e34d965adc7a1a68534a8d72025deabd0",
  "token_prefix": "fns_22ba5585"
}
```

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

### List Tokens Request Example

Source: https://faynosync.com/docs/api/tokens/list

Example of how to make a request to the List Tokens endpoint using curl.

```curl
curl --location 'http://localhost:9000/token/list' \
--header 'Authorization: Bearer <jwt_token>'
```

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

### Apply Database Migrations

Source: https://faynosync.com/docs/getting-started/local-development

Apply database migrations using the Go CLI. This should be done on first setup or after schema changes.

```bash
go run faynoSync.go migrate up  
```

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

### Start Bootstrap

Source: https://faynosync.com/docs/api/tuf/start_bootstrap

Initiates the bootstrap process for TUF metadata. This is an asynchronous operation, and the response includes a task ID to track the process status.

```APIDOC
## POST /api/tuf/start_bootstrap

### Description
Initiates the bootstrap process for TUF metadata. This is an asynchronous operation, and the response includes a task ID to track the process status.

### Method
POST

### Endpoint
/api/tuf/start_bootstrap

### Parameters
#### Request Body
- **payload** (object) - Required - The externally generated bootstrap payload, including keys and signed root metadata.

### Request Example
{
  "payload": "<externally_generated_bootstrap_payload>"
}

### Response
#### Success Response (200)
- **data.last_update** (string) - ISO8601 timestamp of the last update (when bootstrap was accepted)
- **data.task_id** (string) - UUID of the bootstrap task; use it to check task status if needed
- **data.admin** (string) - Admin username (present when bootstrap was already completed)
- **data.app** (string) - Application name (present when bootstrap was already completed)
- **data.status** (string) - Task status, e.g. "completed" (present when bootstrap was already completed)
- **message** (string) - "Bootstrap accepted and started in background" when the bootstrap was started

#### Response Example
{
  "data": {
    "last_update": "2023-10-27T10:00:00Z",
    "task_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "admin": "admin_user",
    "app": "my_app",
    "status": "in_progress"
  },
  "message": "Bootstrap accepted and started in background"
}

#### Error Response (409 Conflict)
- **error** (string) - "Bootstrap already completed for this admin and app"

#### Error Response Example
{
  "error": "Bootstrap already completed for this admin and app"
}

### Notes
* Requires a valid JWT in the `Authorization` header (admin user).
* The request payload must be generated externally (TUF tooling or the script from the FaynoSync admin panel); the API does not generate keys or sign root metadata for you.
* Bootstrap runs asynchronously; use `task_id` with the task-status API if you need to wait for completion.
* Paths in `delegations.roles[].paths` should match how your app and updaters (e.g. electron-builder, squirrel_windows) store TUF metadata (e.g. `<owner>/tuf/`, `tuf-<owner>/`).
```

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

### Success Response Example

Source: https://faynosync.com/docs/api/platforms/update

This is an example of a successful response when a platform is updated. The `updatePlatformResult.Updated` field indicates the success status.

```json
{
  "updatePlatformResult.Updated": true
}
```

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

### Success Response Example

Source: https://faynosync.com/docs/api/platforms/create

This is an example of a successful response when a platform is created. The response includes the unique identifier of the newly created platform.

```json
{
  "createPlatformResult.Created": "641459ffb8360d74164e7e3c"
}
```

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

### Example cURL Request (Standard)

Source: https://faynosync.com/docs/api/info/latest

This example demonstrates a standard cURL request to check for an application update using the platform's default updater. It includes parameters for app name, version, channel, platform, architecture, and owner.

```curl
curl -X GET --location 'http://localhost:9000/checkVersion?app_name=secondapp&version=0.0.1&channel=stable&platform=linux&arch=amd64&owner=admin'  
```

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

### Example cURL Request (Specific Updater)

Source: https://faynosync.com/docs/api/info/latest

This example shows how to make a cURL request specifying a particular updater type, in this case, 'electron-builder'. This allows for a customized response format tailored to that updater.

```curl
curl -X GET --location 'http://localhost:9000/checkVersion?app_name=secondapp&version=0.0.1&channel=stable&platform=linux&arch=amd64&owner=admin&updater=electron-builder'  
```

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

### Signup Success Response

Source: https://faynosync.com/docs/api/auth/signup

Example of a successful response (200 OK) after user registration.

```json
{
  "result": "Successfully created admin user."
}
```

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

### Example Request using curl

Source: https://faynosync.com/docs/api/apps/download

This snippet shows how to request a download URL using curl. Ensure the 'key' parameter is URL-encoded.

```shell
curl -X GET --location 'http://localhost:9000/download?key=secondapp%2Fstable%2Flinux%2Famd64%2Fsecondapp-0.0.1.deb'
```

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

### Example cURL Request

Source: https://faynosync.com/docs/api/tuf/get_current_targets_metadata

An example of how to make a cURL request to the Get Current Targets Metadata endpoint, including the authorization header.

```curl
curl --location 'http://localhost:9000/tuf/v1/metadata/targets?appName=<app_name>'
--header 'Authorization: Bearer <jwt_token>'
```

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

### Create Project Directory

Source: https://faynosync.com/docs/getting-started/production-deploy

Create a new directory for your FaynoSync project and navigate into it.

```bash
mkdir faynosync
cd faynosync

```

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

### Basic Platform Creation (Manual Updater Default)

Source: https://faynosync.com/docs/api/platforms/create

Use this example to create a platform with the default manual updater. Ensure you replace `<jwt_token>` with your actual JWT token.

```curl
curl --location 'http://localhost:9000/platform/create' \
--header 'Authorization: Bearer <jwt_token>' \
--header 'Content-Type: application/json' \
--data '{  
  "platform": "linux"
}'
```

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

### Configure FaynoSync Admin Dashboard Environment

Source: https://faynosync.com/docs/getting-started/docker-development

Copy the example environment file and configure it for the FaynoSync Admin Dashboard. Ensure VITE_API_URL points to your running FaynoSync API server.

```bash
cp .env.example .env  
```

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

### Multiple File Upload (Standard)

Source: https://faynosync.com/docs/api/apps/update-specific-version-app

This example shows how to upload multiple application binary files for a standard update. This is useful for distributing applications across different architectures or platforms simultaneously.

```bash
curl --location 'http://localhost:9000/apps/update' \
--header 'Authorization: Bearer <jwt_token>' \
--form 'data="{\"id\": \"653a6268f51dee6a99a3d88c\", \"app_name\": \"secondapp\", \"version\": \"0.0.2\", \"channel\": \"stable\", \"publish\": true, \"platform\": \"linux\", \"arch\": \"amd64\", \"changelog\": \"\"}"' \
--form 'file=@"/path_to_file/secondapp.deb"' \
--form 'file=@"/path_to_file/secondapp.rpm"'
```

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

### Get TUF Config Request

Source: https://faynosync.com/docs/api/tuf/get_config

Example cURL command to retrieve the TUF configuration for a given application name. Ensure you replace placeholders with actual values.

```shell
curl --location 'http://localhost:9000/tuf/v1/config?appName=<app-name>'
--header 'Authorization: Bearer <jwt_token>'
```

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

### Get Delegated Metadata Request

Source: https://faynosync.com/docs/api/tuf/get_current_delegated_metadata

Example cURL request to retrieve delegated metadata for a specific application and role. Ensure you include a valid JWT token in the Authorization header.

```bash
curl --location 'http://localhost:9000/tuf/v1/metadata/delegated?appName=tuf&roleName=default' \
--header 'Authorization: Bearer <jwt_token>'
```

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

### Single File Upload (Standard)

Source: https://faynosync.com/docs/api/apps/update-specific-version-app

Use this example to upload a single application binary file for a standard update. Ensure the 'data' field contains the application's metadata.

```bash
curl --location 'http://localhost:9000/apps/update' \
--header 'Authorization: Bearer <jwt_token>' \
--form 'data="{\"id\": \"653a6268f51dee6a99a3d88c\", \"app_name\": \"secondapp\", \"version\": \"0.0.2\", \"channel\": \"stable\", \"publish\": true, \"platform\": \"linux\", \"arch\": \"amd64\", \"changelog\": \"\"}"' \
--form 'file=@"/path_to_file/secondapp.deb"'
```

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

### Get All Platforms Endpoint

Source: https://faynosync.com/docs/api/platforms/get

The GET endpoint to retrieve a list of all available platforms.

```http
GET /platform/list
```

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

### Enable Nginx Site Configuration

Source: https://faynosync.com/docs/getting-started/production-deploy

Create a symbolic link to enable the Faynosync Nginx site configuration. This makes the configuration active.

```bash
sudo ln -s /etc/nginx/sites-available/faynosync.conf /etc/nginx/sites-enabled/
```

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

### POST /tuf/v1/bootstrap

Source: https://faynosync.com/docs/api/tuf/start_bootstrap

Starts the TUF bootstrap process for a specified application. This operation initializes the TUF repository with role metadata, expiration settings, and delegations. It runs asynchronously, and a task ID is returned to monitor progress.

```APIDOC
## POST /tuf/v1/bootstrap

### Description
Starts the TUF bootstrap process for a specified application. This operation initializes the TUF repository with role metadata, expiration settings, and delegations. It runs asynchronously, and a task ID is returned to monitor progress. Call Check Bootstrap first to ensure bootstrap has not already been completed for this admin and app.

### Method
POST

### Endpoint
/tuf/v1/bootstrap

### Headers
- **Content-Type**: `application/json`
- **Authorization**: `Bearer <token>`

### Request Body
The body must be a JSON object with TUF bootstrap payload: role settings, root metadata (signed), and the application name.

- **appName** (string) - Required - Name of the application to bootstrap
- **settings** (object) - Required - Role and delegation settings (expiration for root, timestamp, snapshot, targets; delegations keys and roles with paths)
- **metadata** (object) - Required - TUF metadata; must include signed `root` metadata with `signatures` and `signed` (keys, roles, version, spec_version, expires, etc.)

### Request Example
```json
{
  "settings": {
    "roles": {
      "root": { "expiration": 364 },
      "timestamp": { "expiration": 1 },
      "snapshot": { "expiration": 6 },
      "targets": { "expiration": 6 },
      "delegations": {
        "keys": {
          "<key_id>": {
            "keytype": "ed25519",
            "scheme": "ed25519",
            "keyval": { "public": "<public_key_hex>" }
          }
        },
        "roles": [
          {
            "name": "default",
            "terminating": false,
            "keyids": ["<key_id>"],
            "threshold": 1,
            "paths": ["<owner>/tuf/", "tuf-<owner>/", "electron-builder/tuf-<owner>/", "squirrel_windows/tuf-<owner>/"]
          }
        ]
      }
    }
  },
  "metadata": {
    "root": {
      "signatures": [
        { "keyid": "<key_id>", "sig": "<signature_hex>" }
      ],
      "signed": {
        "_type": "root",
        "version": 1,
        "spec_version": "1.0.31",
        "expires": "<ISO8601>",
        "consistent_snapshot": true,
        "keys": { ... },
        "roles": {
          "root": { "keyids": [...], "threshold": 2 },
          "timestamp": { "keyids": [...], "threshold": 1 },
          "snapshot": { "keyids": [...], "threshold": 1 },
          "targets": { "keyids": [...], "threshold": 1 }
        }
      }
    }
  },
  "appName": "<app_name>"
}
```

### Response
#### Success Response (200 OK)
When bootstrap has not been completed yet, the request is accepted and bootstrap runs in the background:
```json
{
  "data": {
    "last_update": "2026-02-04T14:28:12+02:00",
    "task_id": "ecca335d-9192-4fc2-bbb0-3d7a38a55c84"
  },
  "message": "Bootstrap accepted and started in background"
}
```

#### Error Response (Bootstrap Already Completed)
When bootstrap has already been completed for this admin and app, the API returns an error and the existing task info:
```json
{
  "data": {
    "admin": "ku9n",
    "app": "tuf",
    "status": "completed",
    "task_id": "ecca335d-9192-4fc2-bbb0-3d7a38a55c84"
  },
  "error": "Bootstrap already completed for this admin and app"
}
```
```

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

### Example Health Check Request

Source: https://faynosync.com/docs/api/info/health

Example cURL command to request the health status of the FaynoSync service.

```curl
curl -X GET http://localhost:9000/health
```

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

### Run FaynoSync Admin Dashboard in Development Mode

Source: https://faynosync.com/docs/getting-started/docker-development

Start the FaynoSync Admin Dashboard in development mode. This will launch the dashboard on http://localhost:3000 or the port specified in your .env file.

```bash
yarn dev  
```

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

### Example DELETE Request

Source: https://faynosync.com/docs/api/apps/delete

Example of how to make a DELETE request to the application deletion endpoint using curl.

```curl
curl -X DELETE http://localhost:9000/app/delete?id=64145ebaedd163d59d52e1dc \
-H "Authorization: Bearer <jwt_token>"
```

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

### Run FaynoSync Test Suite

Source: https://faynosync.com/docs/getting-started/local-development

Execute the test suite to verify that your local development environment is correctly configured and all components are functioning as expected.

```bash
go test  
```

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

### Fetch Specific App Build

Source: https://faynosync.com/docs/api/info/fetch-latest-build

Use specific parameters like platform and architecture to retrieve details for a particular build. This example requests the latest stable Linux amd64 build for 'secondapp'.

```bash
GET /apps/latest?app_name=secondapp&channel=stable&platform=linux&arch=amd64&owner=admin  
```

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

### Build and Run FaynoSync API with Docker Compose

Source: https://faynosync.com/docs/getting-started/docker-development

Build and run the FaynoSync API along with all its dependencies using Docker Compose. This is suitable for initial setup and testing.

```bash
docker compose up --build  
```

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

### Response: Publishing Started

Source: https://faynosync.com/docs/api/tuf/publish

This JSON response indicates that artifact publishing has started in the background and provides a task ID for monitoring.

```json
{
  "data": {
    "app_id": "69259667351f660c2fd62d39",
    "artifacts": [
      "<app-name>-<admin-name>/<channel>/<platform>/<arch>/<app-name>-<version>"
    ],
    "last_update": "2026-02-04T16:59:30.428313+02:00",
    "task_id": "28dbd3d4-a3f9-40a8-8e0b-94ad0437e36d",
    "version": "0.0.0.5"
  },
  "message": "Artifact(s) publishing started"
}
```

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

### Update with Updater Parameter (Squirrel Windows)

Source: https://faynosync.com/docs/api/apps/update-specific-version-app

This example demonstrates updating an application with the 'squirrel_windows' updater type. It requires uploading both the application binary and the RELEASES file.

```bash
curl --location 'http://localhost:9000/apps/update' \
--header 'Authorization: Bearer <jwt_token>' \
--form 'data="{\"id\": \"653a6268f51dee6a99a3d88c\", \"app_name\": \"secondapp\", \"version\": \"0.0.2\", \"channel\": \"stable\", \"publish\": true, \"platform\": \"windows\", \"arch\": \"amd64\", \"updater\": \"squirrel_windows\", \"changelog\": \"\"}"' \
--form 'file=@"/path_to_file/secondapp.exe"' \
--form 'file=@"/path_to_file/RELEASES"'
```

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

### Create Nginx Configuration File

Source: https://faynosync.com/docs/getting-started/production-deploy

Create the Nginx configuration file for Faynosync. This file defines how Nginx will proxy requests to the backend API.

```bash
sudo nano /etc/nginx/sites-available/faynosync.conf
```

```nginx
server {
    server_name faynosync.example.com;
    client_max_body_size 1000M;
      
    # Pass all requests to the backend API server
    location / {
        proxy_pass http://127.0.0.1:9000;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
  
        # Additional headers for the API
        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;
  
        # Timeout settings
        proxy_connect_timeout 60;
        proxy_send_timeout 60;
        proxy_read_timeout 60;
        send_timeout 60;
    }
      
    # Optional: Cache checkVersion endpoint to reduce server load
    location = /checkVersion {
        proxy_pass http://127.0.0.1:9000;
  
        # Cache configuration
        proxy_cache checkversion_cache;
        proxy_cache_valid 200 60s;
        proxy_cache_use_stale error timeout updating http_500 http_502 http_503 http_504;
        proxy_cache_lock on;
        proxy_cache_lock_timeout 65s;
        proxy_cache_background_update on;
        proxy_cache_key "$scheme$request_method$host$request_uri";
        add_header X-Cache-Status $upstream_cache_status;
  
        # Rate limiting (optional)
        # limit_req zone=req_limit burst=20 nodelay;
  
        # Headers
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
        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;
  
        # Timeouts
        proxy_connect_timeout 60;
        proxy_send_timeout 60;
        proxy_read_timeout 60;
        send_timeout 60;
    }
  
    access_log /var/log/nginx/faynosync.access.log;
    error_log /var/log/nginx/faynosync.error.log;
  
    listen 80;
}

```

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

### Example Request for Metadata Rotation

Source: https://faynosync.com/docs/api/tuf/metadata_rotation

An example cURL request to rotate TUF root metadata, including an empty signatures array for draft flow.

```bash
curl --location 'http://localhost:9000/tuf/v1/metadata?appName=<app-name>' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <jwt_token>' \
--data '{ \
  "metadata": { \
    "root": { \
      "signatures": [], \
      "signed": { \
        "_type": "root", \
        "consistent_snapshot": true, \
        "expires": "2026-12-21T12:52:51.723305Z", \
        "keys": { \
          "<key_id>": { \
            "keytype": "ed25519", \
            "scheme": "ed25519", \
            "keyval": { "public": "<public_key_hex>" } \
          } \
        }, \
        "roles": { \
          "root": { "keyids": ["<key_id>", ...], "threshold": 2 }, \
          "timestamp": { "keyids": ["<key_id>"], "threshold": 1 }, \
          "snapshot": { "keyids": ["<key_id>"], "threshold": 1 }, \
          "targets": { "keyids": ["<key_id>"], "threshold": 1 } \
        }, \
        "spec_version": "1.0.31", \
        "version": 2 \
      } \
    } \
  } \
}'
```

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

### Example cURL Request

Source: https://faynosync.com/docs/api/tuf/check_bootstrap

Example of how to call the Check Bootstrap Status endpoint using cURL. Ensure you replace <app_name> and <jwt_token> with your actual values.

```curl
curl --location 'http://localhost:9000/tuf/v1/bootstrap?appName=<app_name>' \
--header 'Authorization: Bearer <jwt_token>'
```

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

### Deploy FaynoSync with Docker Compose

Source: https://faynosync.com/docs/getting-started/production-deploy

Start the FaynoSync container in detached mode using the docker compose up command. This command reads the docker-compose.yaml file to set up and run the service.

```bash
docker compose up -d

```

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

### Example Squirrel Windows Update Request

Source: https://faynosync.com/docs/api/info/squirrel-windows

Example of a cURL request to the Squirrel Windows update endpoint. Note the structure of the URL with path segments.

```curl
curl --location 'http://localhost:9000/update/admin/secondapp/stable/windows/amd64/0.0.0.1/RELEASES'
```

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

### POST /app/create

Source: https://faynosync.com/docs/api/apps/create

Creates a new application with optional parameters including description, logo, and privacy settings.

```APIDOC
## POST /app/create

### Description
Creates a new application with optional parameters including description, logo, and privacy settings.

### Method
POST

### Endpoint
/app/create

### Authentication
Header: `Authorization: Bearer <jwt_token>`

### Parameters
#### Request Body
- **app** (string) - Required - The name of the application to be created
- **file** (file) - Optional - Logo of the application
- **description** (string) - Optional - App description
- **private** (boolean) - Optional - Lock app (if selected, the app will be stored in a private bucket and cannot be changed)
- **tuf** (boolean) - Optional - Enable TUF framework for application

### Request Example
```json
{
  "app": "appName"
}
```

### Response
#### Success Response (200 OK)
- **createAppResult.Created** (string) - The unique identifier (ID) of the created application

#### Response Example
```json
{
  "createAppResult.Created": "641459ffb8760d74164e7e3c"
}
```

### Notes
- The `private` field is irreversible - once set to `true`, the app cannot be made public later
- The `file` field accepts common image formats (PNG, JPG, etc.)
- The `description` field is optional but recommended for better app management
```

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

### cURL Example for Creating an Application

Source: https://faynosync.com/docs/api/apps/create

Use this cURL command to create a new application. Ensure you replace `<jwt_token>` with your valid JWT token and adjust the `appName` as needed. The `data` field should be a JSON string representing the application details.

```bash
curl --location 'http://localhost:9000/app/create' \
--header 'Authorization: Bearer <jwt_token>' \
--form 'data="{\"app\":\"appName\"}"' 
```

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

### Example cURL Request for TUF Task Status

Source: https://faynosync.com/docs/api/tuf/check_tasks

An example cURL command to check the status of a TUF task. Ensure you replace `<jwt_token>` with a valid token.

```curl
curl --location 'http://localhost:9000/tuf/v1/task?task_id=ecca335d-9192-4fc2-bbb0-3d7a38a55c84' \
--header 'Authorization: Bearer <jwt_token>'
```

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

### Force Metadata Update Request Example

Source: https://faynosync.com/docs/api/tuf/force_metadata_update

Example of a cURL request to force an update of snapshot, timestamp, and targets roles. Ensure to replace placeholders for app name and token.

```curl
curl --location 'http://localhost:9000/tuf/v1/metadata/online?appName=<app_name>' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <jwt_token>' \
--data '{ \
  "roles": ["targets", "snapshot", "timestamp"] \
}'
```

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

### Example cURL Request to Delete Channel

Source: https://faynosync.com/docs/api/channels/delete

This example demonstrates how to use cURL to send a DELETE request to the channel deletion endpoint, including the necessary authorization header and channel ID.

```curl
curl -X DELETE http://localhost:9000/channel/delete?id=64145ebaedd163d59d52e1dc \
-H "Authorization: Bearer <jwt_token>"
```

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

### View Faynosync Backend Logs

Source: https://faynosync.com/docs/getting-started/production-deploy

Follow the logs of the FaynoSync backend service in real-time.

```bash
docker compose logs -f backend
```

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

### Example Platform Configuration for Squirrel Windows

Source: https://faynosync.com/docs/api/info/squirrel-windows

Configuration snippet showing how to set 'squirrel_windows' as the default updater for a platform. This is required for the endpoint to function correctly.

```json
{
  "id": "689f076f9ed9e38071926986",
  "platform": "windows",
  "updaters": [
    { "type": "manual", "default": false },
    { "type": "squirrel_windows", "default": true }
  ]
}
```

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

### Platform with Multiple Updaters

Source: https://faynosync.com/docs/api/platforms/create

This example demonstrates creating a platform with multiple updater types configured, including specifying which one is the default. Replace `<jwt_token>` with your actual JWT token.

```curl
curl --location 'http://localhost:9000/platform/create' \
--header 'Authorization: Bearer <jwt_token>' \
--header 'Content-Type: application/json' \
--data '{  
  "platform": "windows",  
  "updaters": [  
    {"type": "manual", "default": true},  
    {"type": "squirrel_windows", "default": false},  
    {"type": "electron-builder"}  
  ]
}'
```

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

### Delete Specific Artifact Request Example

Source: https://faynosync.com/docs/api/apps/delete-specific-artifact

Example using curl to send a POST request to delete specific artifacts. Ensure to replace `<jwt_token>` with your actual token and adjust the `id`, `app_name`, `version`, and `artifacts_to_delete` values as needed.

```curl
curl --location 'http://localhost:9000/apps/update' \
--header 'Authorization: Bearer <jwt_token>' \
--form 'data="{\"id\":\"653a5e4f51ce5114611f5abb\", \"app_name\":\"secondapp\", \"version\":\"0.0.1\", \"artifacts_to_delete\":[\"0\"]}"' 
```

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

### Get All Channels Endpoint

Source: https://faynosync.com/docs/api/channels/get

This is the endpoint for retrieving all deployment channels.

```bash
GET /channel/list
```
Tokens:
Raw