Flux

https://docs.runonflux.com/
Admin
Flux is a globally distributed computing network powered by 10,000+ community-operated nodes across...
Tokens:179,351
Snippets:2,587
Trust Score:9.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### Deploy Example Next.js Blog

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/getting-started/first-deployment

Use this command to deploy a pre-configured Next.js blog example. It clones the repository, detects the project type, installs dependencies, builds, and starts the application.

```bash
docker run -d \
  --name my-first-app \
  -e GIT_REPO_URL=https://github.com/timlrx/tailwind-nextjs-starter-blog \
  -e APP_PORT=3000 \
  -p 3000:3000 \
  -p 9001:9001 \
  runonflux/orbit:latest
```

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

### Slim Framework Example Index File

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-php

Example `public/index.php` for a Slim application, setting up basic GET routes for the root and a health check endpoint with JSON responses.

```php
<?php  
  
use Psr\Http\Message\ResponseInterface as Response;  
use Psr\Http\Message\ServerRequestInterface as Request;  
use Slim\Factory\AppFactory;  
  
require __DIR__ . '/../vendor/autoload.php';  
  
$app = AppFactory::create();  
  
$app->get('/', function (Request $request, Response $response) {  
    $data = ['message' => 'Slim API', 'version' => '1.0.0'];  
    $response->getBody()->write(json_encode($data));  
    return $response->withHeader('Content-Type', 'application/json');  
});  
  
$app->get('/health', function (Request $request, Response $response) {  
    $data = ['status' => 'healthy'];  
    $response->getBody()->write(json_encode($data));  
    return $response->withHeader('Content-Type', 'application/json');  
});  
  
$app->run();
```

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

### Example pre-deploy.sh Script for Database Migrations

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/configuration/environment-reference

This script runs database migrations using Prisma before the application starts. Ensure the script is executable and placed in your repository root.

```bash
#!/bin/bash
# pre-deploy.sh - Database migrations
set -e
npx prisma migrate deploy

```

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

### Deploy FastAPI Realworld Example App

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/getting-started/quick-start

Example configuration for deploying the FastAPI realworld example application.

```shell
GIT_REPO_URL: https://github.com/tiangolo/fastapi-realworld-example-app  
APP_PORT: 8000  

```

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

### Example requirements.txt for LLM

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/gpu-ai-applications

This is an example requirements.txt file for a typical LLM application. Ensure all listed dependencies are installed in your environment.

```python
torch>=2.0
transformers>=4.35.0
accelerate
bitsandbytes
vllm
```

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

### Deploy shadcn/ui Monorepo Example

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/getting-started/quick-start

Example configuration for deploying a specific project path from the shadcn/ui monorepo.

```shell
GIT_REPO_URL: https://github.com/shadcn-ui/ui  
APP_PORT: 3000  
PROJECT_PATH: apps/www  

```

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

### Run FluxCore Installation Script

Source: https://docs.runonflux.com/fluxcore/installation/linux-headless-installation

Execute the FluxCore setup script to bind your machine to your SSO account. Replace placeholders with your machine's IP and your email address. The '-cluster default' flag joins your region's cluster.

```bash
bash -i <(curl -s https://download.fluxcore.ai/setup.sh) -i 192.168.1.100 youremail@mail.com -cluster default
```

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

### Lumen Framework Example Routes

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-php

Example `routes/web.php` file for a Lumen application, demonstrating basic GET routes for the root and a health check endpoint.

```php
<?php  
  
/** @var \Laravel\Lumen\Routing\Router $router */  
  
$router->get('/', function () use ($router) {  
    return response()->json([  
        'message' => 'Lumen API',  
        'version' => $router->app->version()  
    ]);  
});  
  
$router->get('/health', function () {  
    return response()->json(['status' => 'healthy']);  
});
```

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

### Deployment Log Output Example

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/getting-started/first-deployment

This is an example of the output you will see in the logs during a successful deployment, showing the steps from cloning to application startup.

```text
[SETUP] Starting Git deployment... 
[SETUP] Cloning repository: https://github.com/timlrx/tailwind-nextjs-starter-blog 
[SETUP] Repository cloned successfully 
[SETUP] Detected Node.js project (found package.json) 
[SETUP] Installing Node.js v20.11.0... 
[SETUP] Running npm install... 
[SETUP] Dependencies installed successfully 
[SETUP] Running build command: npm run build 
[SETUP] Build completed successfully 
[SETUP] Starting application with command: npm start 
[APP] ▲ Next.js 14.0.0 
[APP] - Local: http://localhost:3000
```

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

### Specify Application Start Command

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/troubleshooting/common-issues

If your application crashes immediately upon starting, ensure the correct command is specified to launch your application.

```bash
-e RUN_COMMAND="node server.js"
```

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

### Download and Install CUDA Toolkit

Source: https://docs.runonflux.com/fluxcore/installation/linux-headless-installation

Download the CUDA keyring, install it, update package lists, and install the CUDA toolkit for Ubuntu 22.04.

```bash
wget https://developer.download.nvidia.com/compute/cuda/repos/ubuntu2204/x86_64/cuda-keyring_1.1-1_all.deb
sudo dpkg -i cuda-keyring_1.1-1_all.deb
sudo apt-get update
sudo apt-get install -y nvidia-cuda-toolkit
sudo apt install cuda-toolkit-12-8
```

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

### Install Nano Text Editor

Source: https://docs.runonflux.com/fluxcloud/marketplace/games/enshrouded

Install the Nano text editor, which is required for editing server configuration files. This only needs to be done once.

```bash
apt install nano
```

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

### Pre-deploy Script to Download Model Weights

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/gpu-ai-applications

An example bash script to download model weights using Python's Transformers library before the application starts. This ensures models are available at runtime.

```bash
#!/bin/bash
# Download model weights before starting
python -c "from transformers import AutoModel; AutoModel.from_pretrained('bert-base-uncased')"
echo "Model downloaded successfully"
```

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

### View Application and Setup Logs

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/getting-started/first-deployment

Use `docker exec` to view the application's runtime logs or the logs generated during the deployment setup process.

```bash
# Test if application responds
curl http://localhost:3000

# Check application logs
docker exec my-first-app tail -f /app/logs/app.log

# View setup logs
docker exec my-first-app cat /app/logs/setup.log
```

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

### V Rising Server Host Settings Example

Source: https://docs.runonflux.com/fluxcloud/marketplace/games/vrising

Example of the ServerHostSettings.json file. The 'WorldName' field must exactly match the uploaded world folder name, including case.

```json
"WorldName": "MyOldWorld"
```

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

### Register Satisfactory Server Installation with ficsit-cli

Source: https://docs.runonflux.com/fluxcloud/marketplace/games/satisfactory

Register the game's installation directory with `ficsit-cli` to allow it to manage mods. This command should be run after downloading and preparing the `ficsit-cli` tool.

```bash
/tmp/ficsit installation add /config/gamefiles
```

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

### Example Go Project Structure

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-go

An example directory structure for a Go API project, including module definition, source files, and optional hooks.

```tree
my-go-api/  
├── go.mod                 # Module definition  
├── go.sum                 # Dependency checksums  
├── .go-version           # Optional: Pin Go version  
├── main.go               # Application entry point  
├── pre-deploy.sh         # Optional: Pre-deployment hook  
├── post-deploy.sh        # Optional: Post-deployment hook  
├── handlers/  
│   ├── users.go  
│   └── auth.go  
├── models/  
│   └── user.go  
└── middleware/  
    └── auth.go  

```

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

### Example Program.cs for Worker Service

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-dotnet

This is an example Program.cs file for a .NET Worker Service. It demonstrates setting up a background service that logs the current time periodically.

```csharp
using Microsoft.Extensions.Hosting;  
  
var builder = Host.CreateApplicationBuilder(args);  
builder.Services.AddHostedService<Worker>();  
  
var host = builder.Build();  
host.Run();  
  
public class Worker : BackgroundService  
{
    private readonly ILogger<Worker> _logger;  

    public Worker(ILogger<Worker> logger)  
    {
        _logger = logger;  
    }

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)  
    {
        while (!stoppingToken.IsCancellationRequested)  
        {
            _logger.LogInformation("Worker running at: {time}", DateTimeOffset.Now);
            await Task.Delay(10000, stoppingToken);
        }
    }
}

```

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

### Install NVIDIA Desktop Driver

Source: https://docs.runonflux.com/fluxcore/installation/linux-headless-installation

Install the NVIDIA 570 desktop driver for Ubuntu Desktop.

```bash
sudo apt install nvidia-driver-570
```

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

### PNPM Install Commands

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-nodejs

Set up PNPM for dependency installation, utilizing frozen lockfile options for consistency.

```bash
# PNPM with frozen lockfile
-e INSTALL_COMMAND="pnpm install --frozen-lockfile"
```

```bash
# Production only
-e INSTALL_COMMAND="pnpm install --prod --frozen-lockfile"
```

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

### Install NVIDIA Server Driver

Source: https://docs.runonflux.com/fluxcore/installation/linux-headless-installation

Install the NVIDIA 570 server driver for Ubuntu Server.

```bash
sudo apt install nvidia-driver-570-server
```

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

### Install CUDA Toolkit and Dependencies

Source: https://docs.runonflux.com/fluxcore/installation/linux-installation

Installs the CUDA toolkit and necessary dependencies for GPU benchmarking. Ensure CUDA is installed before FluxCore.

```bash
wget https://developer.download.nvidia.com/compute/cuda/repos/ubuntu2204/x86_64/cuda-keyring_1.1-1_all.deb
sudo dpkg -i cuda-keyring_1.1-1_all.deb
sudo apt-get update
sudo apt-get install -y nvidia-cuda-toolkit
sudo apt install -y cuda-toolkit-12-8
```

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

### Install Additional Dependencies with Deployment Hooks

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-ruby

For native extension build errors during `bundle install`, use deployment hooks to install necessary development libraries.

```bash
#!/bin/bash  
# pre-deploy.sh  
apt-get update && apt-get install -y libspecial-dev  

```

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

### Specify Start Command

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/getting-started/quick-start

Use this to set a custom start command if your application uses a different one.

```shell
RUN_COMMAND: npm run start:prod  

```

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

### Example build.gradle Configuration

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-java

This is an example of a build.gradle file for a Spring Boot project, demonstrating plugin applications, group, version, Java compatibility, repositories, and dependencies.

```gradle
plugins {
    id 'java'
    id 'org.springframework.boot' version '3.2.0'
    id 'io.spring.dependency-management' version '1.1.4'
}

group = 'com.example'
version = '1.0.0'

java {
    sourceCompatibility = '21'
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-web'
}
```

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

### Example build.gradle.kts Configuration (Kotlin DSL)

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-java

This is an example of a build.gradle.kts file using Kotlin DSL for a Spring Boot project, demonstrating plugin applications, group, version, Java compatibility, repositories, and dependencies.

```gradle
plugins {
    java
    id("org.springframework.boot") version "3.2.0"
    id("io.spring.dependency-management") version "1.1.4"
}

group = "com.example"
version = "1.0.0"

java {
    sourceCompatibility = JavaVersion.VERSION_21
}

repositories {
    mavenCentral()
}

dependencies {
    implementation("org.springframework.boot:spring-boot-starter-web")
}
```

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

### Example requirements.txt for Image Generation

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/gpu-ai-applications

This is an example requirements.txt file for an image generation application. It includes common libraries like PyTorch, diffusers, and transformers.

```python
torch>=2.0
diffusers
transformers
accelerate
safetensors
```

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

### Start a new tmux session

Source: https://docs.runonflux.com/fluxedge/projects/overview/projects-overview

Initiates a new, default tmux session. This is the most basic way to start using tmux.

```bash
tmux
```

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

### Garry's Mod Server Configuration Example

Source: https://docs.runonflux.com/fluxcloud/marketplace/games/garrysmod

Example of common settings within the server.cfg file for customizing your Garry's Mod server, such as hostname, password, and region.

```cfg
hostname "My Flux GMod Server"
sv_password ""
rcon_password "change-me"
sv_region 255
sv_lan 0
sv_loadingurl ""
```

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

### Example Program.cs for ASP.NET Core Minimal API

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-dotnet

This is a minimal example of an ASP.NET Core Web API Program.cs file using minimal APIs. It sets up endpoints for the root path and a health check.

```csharp
var builder = WebApplication.CreateBuilder(args);  
  
builder.Services.AddEndpointsApiExplorer();  
builder.Services.AddSwaggerGen();  
  
var app = builder.Build();  
  
if (app.Environment.IsDevelopment())  
{
    app.UseSwagger();  
    app.UseSwaggerUI();  
}
  
app.MapGet("/", () => new { message = "ASP.NET Core API", version = "1.0.0" });  
app.MapGet("/health", () => Results.Ok(new { status = "healthy" }));  
  
app.Run();  

```

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

### Deploy Next.js Starter Blog

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/getting-started/quick-start

Example configuration for deploying the tailwind-nextjs-starter-blog from GitHub.

```shell
GIT_REPO_URL: https://github.com/timlrx/tailwind-nextjs-starter-blog  
APP_PORT: 3000  

```

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

### TShock Setup Command

Source: https://docs.runonflux.com/fluxcloud/marketplace/games/terraria

Run this command in the in-game chat to initiate the TShock superadmin registration process.

```bash
/setup <code>
```

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

### Verify Host Setup with NVIDIA SMI

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/gpu-ai-applications

Use this command to check if the NVIDIA driver is installed on the host machine.

```bash
# Check if NVIDIA driver is installed  
nvidia-smi  
```

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

### Initialize Database on First Run

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-python

Use PRE_BUILD_COMMAND to execute a custom script for initializing the database when the application starts for the first time.

```shell
-e PRE_BUILD_COMMAND="python init_db.py"
```

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

### Response for Getting Preview Details

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/pr-preview-deployments

This is an example JSON response when requesting details for a specific preview. It includes comprehensive information about the preview.

```json
{
  "pr_number": 123,
  "commit": "abc123def",
  "branch": "feature/new-ui",
  "title": "Add new UI",
  "author": "username",
  "status": "ready",
  "created_at": "2025-01-15T10:00:00Z",
  "updated_at": "2025-01-15T10:30:00Z",
  "build_duration": 120
}
```

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

### Configure Bun Entry Point via package.json

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-bun

Define a 'start' script in your `package.json` to specify the entry point for your Bun application. This is an alternative to having a default entry point file.

```json
{  
  "scripts": {  
    "start": "bun run index.ts"  
  }  
}
```

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

### Monitor Deployment Logs

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/getting-started/first-deployment

Watch the real-time logs of your deployment to see the progress of cloning, dependency installation, building, and starting your application.

```bash
docker logs -f my-first-app
```

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

### Installing Project Zomboid Mods via Environment Variables

Source: https://docs.runonflux.com/fluxcloud/marketplace/games/projectzomboid

Configure Steam Workshop IDs and Mod IDs as environment variables to automatically download and install mods on your Project Zomboid server. Mods are activated on the second server start after configuration.

```text
WORKSHOP_IDS=2169435993;2392709985
MOD_IDS=tsarslib;BetterSorting
```

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

### Use 8-bit Quantization for Efficiency

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/gpu-ai-applications

This example shows how to use 8-bit quantization with the Transformers library to reduce memory usage for large language models. Ensure the 'transformers' and 'accelerate' libraries are installed.

```python
from transformers import AutoModelForCausalLM

model = AutoModelForCausalLM.from_pretrained(
    "model-name",
    load_in_8bit=True,  # 8-bit quantization
    device_map="auto"
)
```

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

### Install tmux

Source: https://docs.runonflux.com/fluxedge/projects/overview/projects-overview

Installs tmux on a Debian-based system. Ensure apt-get is updated before installation.

```bash
apt-get update
apt-get install sudo
sudo apt-get install tmux
```

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

### Yarn Install Commands

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-nodejs

Configure Yarn for dependency installation, including options for frozen lockfiles and production-only installs.

```bash
# Yarn with frozen lockfile
-e INSTALL_COMMAND="yarn install --frozen-lockfile"
```

```bash
# Yarn 2+ (Berry)
-e INSTALL_COMMAND="yarn install --immutable"
```

```bash
# Production only
-e INSTALL_COMMAND="yarn install --production --frozen-lockfile"
```

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

### Deploy Microservice with Resource Limits using Docker

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-java

Example Docker command for deploying a microservice with specified memory and CPU limits, including Java options.

```bash
docker run -d \  
  --name user-service \  
  --memory="2g" \  
  --cpus="2" \  
  -e GIT_REPO_URL=https://github.com/company/microservices \  
  -e PROJECT_PATH=user-service \  
  -e APP_PORT=8080 \  
  -e JAVA_OPTS="-Xms512m -Xmx1536m -XX:+UseG1GC" \  
  -p 8080:8080 \  
  runonflux/orbit:latest  

```

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

### NPM Install Commands

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-nodejs

Use these commands to install Node.js dependencies with NPM. 'npm ci' is recommended for faster and more reliable installs.

```bash
# Use npm ci for faster, reliable installs
-e INSTALL_COMMAND="npm ci"
```

```bash
# Production-only dependencies
-e INSTALL_COMMAND="npm ci --production"
```

```bash
# With legacy peer deps (for compatibility)
-e INSTALL_COMMAND="npm ci --legacy-peer-deps"
```

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

### Install Additional PHP Extensions

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/configuration/environment-reference

Specify additional PHP extensions to install, provided as a comma-separated string. Common extensions are installed by default.

```bash
# Install ImageMagick and Memcached extensions
-e PHP_EXTENSIONS="imagick,memcached"
```

```bash
# Install multiple extensions
-e PHP_EXTENSIONS="imagick,memcached,xdebug,mongodb"
```

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

### Example .env File for Environment Variables

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-python

A sample .env file containing common application settings like debug mode, database URL, and secret key.

```dotenv
DEBUG=False
DATABASE_URL=postgresql://localhost/mydb
REDIS_URL=redis://localhost:6379
SECRET_KEY=your-secret-key
ALLOWED_HOSTS=localhost,127.0.0.1  
```

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

### Install Dependencies with Poetry

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-python

For projects using Poetry, if pyproject.toml exists, Flux Cloud executes 'poetry install --no-dev' to install production dependencies.

```bash
# If pyproject.toml exists  
-e INSTALL_COMMAND="poetry install --no-dev"  
```

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

### Deploy Application with Multiple Environment Variables

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/configuration/environment-reference

This example demonstrates deploying an application using the `runonflux/orbit:latest` Docker image with a comprehensive set of environment variables passed directly via the `-e` flag. It includes settings for repository, build, runtime, database, security, and health checks.

```bash
docker run -d \  
  --name production-app \  
  --memory="4g" \  
  -e GIT_REPO_URL=https://github.com/company/main-app \  
  -e GIT_BRANCH=production \  
  -e GIT_TOKEN=ghp_YourToken \  
  -e PROJECT_PATH=apps/web \  
  -e APP_PORT=3000 \  
  -e NODE_VERSION=20.11.0 \  
  -e BUILD_COMMAND="npm run build:production" \  
  -e RUN_COMMAND="npm run start:production" \  
  -e DATABASE_URL=postgresql://user:pass@db:5432/prod \  
  -e WEBHOOK_SECRET=webhook_secret_123 \  
  -e API_KEY=api_key_456 \  
  -e POLLING_INTERVAL=300 \  
  -e HEALTH_CHECK_RETRIES=5 \  
  -e HEALTH_CHECK_DELAY=10 \  
  -e HOOK_TIMEOUT=600 \  
  -e DEPLOYMENT_TIMEOUT=1800 \  
  -p 3000:3000 \  
  -p 9001:9001 \  
  runonflux/orbit:latest  

```

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

### Configure Rackup Server Binding

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-ruby

Ensure your server binds to `0.0.0.0` to be accessible. This example shows how to configure Rackup via the command line.

```bash
# Use 'rackup -o 0.0.0.0 -p $PORT'  

```

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

### Verify Dependency Installation for Production Hooks

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/hooks/deployment-hooks

Ensure that dependencies are installed before the pre-deploy hook runs. If dependencies are already installed, the hook should execute successfully. This snippet assumes dependencies are handled prior to the hook execution.

```bash
# Ensure this is in pre-deploy.sh (after dependencies)  
# Dependencies are already installed before pre-deploy runs  
npx prisma migrate deploy  # Should work  
```

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

### Deploying a Slim Framework Application

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-php

Deploy a Slim framework API or web application. Deploy with Git automatically detects the document root and starts the server.

```docker
docker run -d \
  --name slim-api \
  -e GIT_REPO_URL=https://github.com/your-username/slim-api \
  -e APP_PORT=8000 \
  -p 8000:8000 \
  runonflux/orbit:latest
```

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

### Example .NET Repository Structure

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-dotnet

This illustrates a typical file and directory structure for a .NET API project, including solution, project files, configuration, controllers, and services.

```tree
my-dotnet-api/  
├── MyApi.sln              # Solution file  
├── MyApi.csproj          # Project file with dependencies  
├── packages.lock.json    # Locked package versions (optional)  
├── global.json           # SDK version specification (optional)  
├── nuget.config          # NuGet feed configuration (optional)  
├── pre-deploy.sh         # Optional: Pre-deployment hook  
├── post-deploy.sh        # Optional: Post-deployment hook  
├── Program.cs            # Application entry point  
├── appsettings.json      # Application configuration  
├── appsettings.Production.json  
├── Controllers/  
│   └── WeatherController.cs  
├── Models/  
│   └── WeatherForecast.cs  
├── Services/  
│   └── IWeatherService.cs  
└── Data/  
    ├── ApplicationDbContext.cs  
    └── Migrations/  

```

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

### Pre-deploy Script for Rust Application

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-rust

Example of a pre-deployment script to run tasks like database migrations before the application is deployed. Place this file in your repository root.

```bash
#!/bin/bash
# Run database migrations before deployment
echo "Running database migrations..."
# Your migration logic here
```

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

### Update System Packages

Source: https://docs.runonflux.com/fluxcore/installation/linux-headless-installation

Update and upgrade all installed packages on your Ubuntu system before installing drivers.

```bash
sudo apt update && sudo apt upgrade -y
```

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

### Download and Prepare ficsit-cli

Source: https://docs.runonflux.com/fluxcloud/marketplace/games/satisfactory

Download the `ficsit-cli` executable, make it executable, and place it in a temporary directory. This is the first step for using the recommended command-line mod management tool.

```bash
curl -L https://github.com/satisfactorymodding/ficsit-cli/releases/latest/download/ficsit_linux_amd64 -o /tmp/ficsit
chmod +x /tmp/ficsit
```

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

### GET /health Response (Application Not Responding)

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/api/webhook-api

The response from GET /health when the application is not responding or is stopped.

```json
{
  "healthy": false,
  "app_status": "not_responding",
  "app_port": 3000,
  "supervisor_status": "STOPPED",
  "deployment_in_progress": false,
  "deployment_stage": "none"
}
```

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

### Example .python-version File

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-python

A .python-version file specifies the exact Python version to use for the application.

```text
3.11.6  
```

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

### Install Dependencies with requirements.txt

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-python

Flux Cloud automatically detects and installs dependencies if a requirements.txt file is present in the repository.

```bash
# requirements.txt is detected automatically  
-e INSTALL_COMMAND="pip install -r requirements.txt"  
```

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

### GET /health Response (Application Healthy)

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/api/webhook-api

The response from GET /health when the application is running and healthy, with no deployment in progress.

```json
{
  "healthy": true,
  "app_status": "running",
  "app_port": 3000,
  "supervisor_status": "RUNNING",
  "deployment_in_progress": false,
  "deployment_stage": "none"
}
```

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

### Check Preview Build Logs

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/pr-preview-deployments

Use this curl command to fetch the build logs for a specific preview. Replace YOUR_KEY and the preview URL with your actual values.

```bash
curl -H "X-API-Key: YOUR_KEY" https://your-app_9001.app.runonflux.io/previews/123  

```

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

### Composer Install for Production

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-php

This command installs Composer dependencies with production optimizations, excluding development-only packages and optimizing the autoloader.

```bash
composer install --no-dev --optimize-autoloader
```

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

### Create React App Configuration for PR Preview Base URL

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/pr-preview-deployments

Set 'homepage' to '.' in package.json for Create React App to correctly handle relative paths during PR preview deployments.

```json
// package.json
{
  "homepage": "."
}
```

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

### Install Command for Module Not Found Errors

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-nodejs

Use 'npm ci' for a clean installation to resolve 'Module Not Found' errors.

```bash
-e INSTALL_COMMAND="npm ci"
```

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

### Example TypeScript Code for Native Execution

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-bun

This is an example of a TypeScript file that can be executed natively by Bun without a build process.

```typescript
interface ApiResponse {
    message: string;
    timestamp: Date;
}

const response: ApiResponse = {
    message: 'TypeScript running natively!',
    timestamp: new Date()
};

console.log(response);

```

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

### Configure Server Hostname and Description

Source: https://docs.runonflux.com/fluxcloud/marketplace/games/rust

You can set the server hostname and description directly in `server.cfg`. These settings will override any configured during deployment and are loaded after launch arguments.

```plaintext
server.hostname "..."
```

```plaintext
server.description "..."
```

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

### GET /health Response (During Deployment)

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/api/webhook-api

The response from GET /health when a deployment is in progress, indicating the application is running but undergoing deployment.

```json
{
  "healthy": true,
  "app_status": "running",
  "app_port": 3000,
  "supervisor_status": "RUNNING",
  "deployment_in_progress": true,
  "deployment_stage": "building"
}
```

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

### Deploy Simple Gin API

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-go

Use this command to deploy a basic Gin API. Ensure your GitHub repository contains a `go.mod` file.

```docker
docker run -d \
  --name gin-api \
  -e GIT_REPO_URL=https://github.com/your-username/gin-api \
  -e APP_PORT=8080 \
  -p 8080:8080 \
  runonflux/orbit:latest  

```

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

### Start Flux-Orbit with Docker Compose

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/getting-started/installation

Use this command to start the Flux-Orbit service defined in your docker-compose.yml file in detached mode.

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

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

### Load Models Once at Startup

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/gpu-ai-applications

Demonstrates the correct way to load AI models once during application startup to avoid performance degradation. Avoid loading models on every request.

```python
# Good: Load once
model = None

@app.on_event("startup")
async def load_model():
    global model
    model = AutoModel.from_pretrained("model-name")
    model.to("cuda")

# Bad: Load every request
@app.post("/predict")
async def predict():
    model = AutoModel.from_pretrained("model-name")  # Don't do this!
```

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

### Example Gin API main.go

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/guides/deploying-go

A sample `main.go` file for a Gin web application. It sets up a health check endpoint and listens on a configurable port.

```go
package main  
  
import (  
    "os"  
    "github.com/gin-gonic/gin"  
)  
  
func main() {  
    router := gin.Default()  
    router.GET("/health", func(c *gin.Context) {  
        c.JSON(200, gin.H{"status": "healthy"})  
    })  
  
    port := os.Getenv("APP_PORT")  
    if port == "" {  
        port = "8080"  
    }  
    router.Run("0.0.0.0:" + port)  
}  

```

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

### Deploy Spring Boot API from Git

Source: https://docs.runonflux.com/fluxcloud/register-new-app/deploy-with-git/introduction

Set up the deployment for a Spring Boot API. This includes the app name, Docker image, Git repository, and the application's port.

```bash
App Name: my-spring-api
Docker Image: runonflux/:latest
Git Repo: https://github.com/you/spring-boot-app
Port: 8080
```
Tokens:
Raw