# Configuración de servicios back-end

Ejecute el SDK de Copilot en aplicaciones del lado servidor: API, back-end web, microservicios y trabajos en segundo plano. La CLI se ejecuta como un servidor sin encabezado al que se conecta el código back-end a través de la red.

<!-- markdownlint-disable GHD046 GHD005 -->

<!-- Suppressed: GHD046 (outdated release terminology), GHD005 (hardcoded data variable) -->

**Lo mejor para:** Back-end de aplicaciones web, servicios de API, herramientas internas, integraciones de CI/CD, cualquier carga de trabajo del lado servidor.

## Cómo funciona

En lugar del SDK que genera un proceso secundario de la CLI, ejecute la CLI de forma independiente en **modo de servidor sin encabezado**. El back-end se conecta a él a través de TCP mediante la `Connection` opción (`URIConnection`).

![Diagrama: Diagrama de flujo que muestra el proceso descrito.](/assets/images/help/copilot/copilot-sdk/setup-backend-services-diagram-0.png)

**Características principales:**

* La CLI se ejecuta como un proceso de servidor persistente (no generado por solicitud)
* El SDK se conecta a través de TCP: la CLI y la aplicación se pueden ejecutar en distintos contenedores
* Varios clientes del SDK pueden compartir un servidor de la CLI
* Funciona con cualquier método de autenticación (tokens de GitHub, vars env, BYOK)

Para el modo de servidor multiusuario, configure los clientes del SDK con `mode: "empty"`, pase las credenciales de usuario por sesión y permita explícitamente herramientas para cada sesión. Consulte [Multiinquilino e implementaciones de servidor](/es/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/setup/multi-tenancy) para obtener el patrón completo.

## Arquitectura: administrada automáticamente frente a la CLI externa

![Diagrama: Diagrama de flujo que muestra el proceso descrito.](/assets/images/help/copilot/copilot-sdk/setup-backend-services-diagram-1.png)

## Paso 1: iniciar la CLI en modo sin encabezado

Ejecute la CLI como servidor en segundo plano:

```bash
# Start with a specific port
copilot --headless --port 4321

# Or let it pick a random port (prints the URL)
copilot --headless
# Output: Listening on http://localhost:52431
```

De manera predeterminada, el servidor sin encabezado solo acepta conexiones desde el bucle invertido (`127.0.0.1`). Para aceptar conexiones de otros hosts (por ejemplo, desde otra máquina de la red), enlace a una dirección que no sea de bucle invertido con `--host`:

```bash
copilot --headless --host 0.0.0.0 --port 4321
```

Para producción, ejecútelo como un servicio del sistema o en un contenedor.

> \[!NOTE]
> No hay ninguna imagen oficial de Docker pregenerada para la CLI de Copilot. Puede compilar el suyo desde las [publicaciones de GitHub](https://github.com/github/copilot-cli/releases):

```dockerfile
FROM debian:bookworm-slim
ARG COPILOT_VERSION=1.0.7
RUN apt-get update \
    && apt-get install -y --no-install-recommends ca-certificates wget \
    && ARCH=$(dpkg --print-architecture) \
    && case "${ARCH}" in amd64) COPILOT_ARCH="x64" ;; arm64) COPILOT_ARCH="arm64" ;; *) echo "Unsupported: ${ARCH}" && exit 1 ;; esac \
    && wget -q "https://github.com/github/copilot-cli/releases/download/v${COPILOT_VERSION}/copilot-linux-${COPILOT_ARCH}.tar.gz" \
    && tar -xzf "copilot-linux-${COPILOT_ARCH}.tar.gz" \
    && mv copilot /usr/local/bin/ \
    && rm "copilot-linux-${COPILOT_ARCH}.tar.gz" \
    && apt-get purge -y wget && apt-get autoremove -y && rm -rf /var/lib/apt/lists/*
ENTRYPOINT ["copilot"]
```

```bash
# Build the image
docker build --build-arg COPILOT_VERSION=1.0.7 -t copilot-cli:latest .

# For remote deployments (Kubernetes, ACI, etc.), push to your registry
docker tag copilot-cli:latest your-registry/copilot-cli:latest
docker push your-registry/copilot-cli:latest
```

```bash
# Docker — must bind to 0.0.0.0 so the container's published port is reachable
docker run -d --name copilot-cli \
    -p 4321:4321 \
    -e COPILOT_GITHUB_TOKEN="$TOKEN" \
    copilot-cli:latest \
    --headless --host 0.0.0.0 --port 4321

# systemd
[Service]
ExecStart=/usr/local/bin/copilot --headless --port 4321
Environment=COPILOT_GITHUB_TOKEN=your-token
Restart=always
```

## Paso 2: conexión del SDK

<div class="ghd-codetabs">
<div class="ghd-codetab" data-lang="typescript" data-label="TypeScript"><div class="ghd-codetab-fallback-label" role="heading" aria-level="3">TypeScript</div>

```typescript
import { CopilotClient, RuntimeConnection } from "@github/copilot-sdk";

const client = new CopilotClient({
    connection: RuntimeConnection.forUri("localhost:4321"),
    mode: "empty",
});

const session = await client.createSession({
    sessionId: `user-${userId}-${Date.now()}`,
    model: "gpt-5.4",
    availableTools: ["custom:*"],
    gitHubToken: user.githubToken,
});

const response = await session.sendAndWait({ prompt: req.body.message });
res.json({ content: response?.data.content });
```

</div>

<div class="ghd-codetab" data-lang="python" data-label="Python"><div class="ghd-codetab-fallback-label" role="heading" aria-level="3">Python</div>

```python
from copilot import CopilotClient, RuntimeConnection
from copilot.session import PermissionHandler

client = CopilotClient(
    connection=RuntimeConnection.for_uri("localhost:4321"),
)
await client.start()

session = await client.create_session(on_permission_request=PermissionHandler.approve_all, model="gpt-5.4", session_id=f"user-{user_id}-{int(time.time())}")

response = await session.send_and_wait(message)
```

</div>

<div class="ghd-codetab" data-lang="go" data-label="Go"><div class="ghd-codetab-fallback-label" role="heading" aria-level="3">Go</div>

```golang
client := copilot.NewClient(&copilot.ClientOptions{
    Connection: copilot.URIConnection{URL: "localhost:4321"},
})
client.Start(ctx)
defer client.Stop()

session, _ := client.CreateSession(ctx, &copilot.SessionConfig{
    SessionID: fmt.Sprintf("user-%s-%d", userID, time.Now().Unix()),
    Model:     "gpt-5.4",
})

response, _ := session.SendAndWait(ctx, copilot.MessageOptions{Prompt: message})
```

</div>

<div class="ghd-codetab" data-lang="dotnet" data-label=".NET"><div class="ghd-codetab-fallback-label" role="heading" aria-level="3">.NET</div>

```csharp
var client = new CopilotClient(new CopilotClientOptions
{
    Connection = RuntimeConnection.ForUri("localhost:4321"),
});

await using var session = await client.CreateSessionAsync(new SessionConfig
{
    SessionId = $"user-{userId}-{DateTimeOffset.UtcNow.ToUnixTimeSeconds()}",
    Model = "gpt-5.4",
});

var response = await session.SendAndWaitAsync(
    new MessageOptions { Prompt = message });
```

</div>

<div class="ghd-codetab" data-lang="java" data-label="Java"><div class="ghd-codetab-fallback-label" role="heading" aria-level="3">Java</div>

```java
import com.github.copilot.CopilotClient;
import com.github.copilot.rpc.*;

var userId = "user1";
var message = "Hello!";

var client = new CopilotClient(new CopilotClientOptions()
    .setCliUrl("localhost:4321")
);

try {
    client.start().get();

    var session = client.createSession(new SessionConfig()
        .setSessionId(String.format("user-%s-%d", userId, System.currentTimeMillis() / 1000))
        .setModel("gpt-5.4")
        .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
    ).get();

    var response = session.sendAndWait(new MessageOptions()
        .setPrompt(message)).get();
} finally {
    client.stop().get();
}
```

</div>

</div>

## Autenticación para servicios back-end

### Tokens de variables de entorno

El enfoque más sencillo: establezca un token en el servidor de la CLI:

![Diagrama: Diagrama de flujo que muestra el proceso descrito.](/assets/images/help/copilot/copilot-sdk/setup-backend-services-diagram-2.png)

```bash
# All requests use this token
export COPILOT_GITHUB_TOKEN="gho_service_account_token"
copilot --headless --port 4321
```

### Tokens de usuario individual (OAuth)

Pase tokens de usuario individuales al crear sesiones. Consulte [Configuración de OAuth de GitHub](/es/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/setup/github-oauth) para obtener el flujo completo.

```typescript
const client = new CopilotClient({
    connection: RuntimeConnection.forUri("localhost:4321"),
    mode: "empty",
});

// Your API receives user tokens from your auth layer
app.post("/chat", authMiddleware, async (req, res) => {
    const session = await client.createSession({
        sessionId: `user-${req.user.id}-chat`,
        model: "gpt-5.4",
        availableTools: ["custom:*"],
        gitHubToken: req.user.githubToken,
    });

    const response = await session.sendAndWait({
        prompt: req.body.message,
    });

    res.json({ content: response?.data.content });
});
```

### BYOK (sin autenticación de GitHub)

Use sus propias claves de API para el proveedor de modelos. Consulte [BYOK (traiga su propia clave)](/es/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/auth/byok) para obtener más información.

```typescript
const client = new CopilotClient({
    connection: RuntimeConnection.forUri("localhost:4321"),
});

const session = await client.createSession({
    model: "gpt-5.4",
    provider: {
        type: "openai",
        baseUrl: "https://api.openai.com/v1",
        apiKey: process.env.OPENAI_API_KEY,
    },
});
```

## Patrones de back-end comunes

### API web con Express

![Diagrama: Diagrama de flujo que muestra el proceso descrito.](/assets/images/help/copilot/copilot-sdk/setup-backend-services-diagram-3.png)

```typescript
import express from "express";
import { CopilotClient, RuntimeConnection } from "@github/copilot-sdk";

const app = express();
app.use(express.json());

// Single shared CLI connection for multi-user server mode
const client = new CopilotClient({
    connection: RuntimeConnection.forUri(process.env.CLI_URL || "localhost:4321"),
    mode: "empty",
});

app.post("/api/chat", async (req, res) => {
    const { sessionId, message } = req.body;

    // Create or resume session
    let session;
    try {
        session = await client.resumeSession(sessionId);
    } catch {
        session = await client.createSession({
            sessionId,
            model: "gpt-5.4",
            availableTools: ["custom:*"],
            gitHubToken: req.user.githubToken,
        });
    }

    const response = await session.sendAndWait({ prompt: message });
    res.json({
        sessionId,
        content: response?.data.content,
    });
});

app.listen(3000);
```

### Trabajo en segundo plano

```typescript
import { CopilotClient, RuntimeConnection } from "@github/copilot-sdk";

const client = new CopilotClient({
    connection: RuntimeConnection.forUri(process.env.CLI_URL || "localhost:4321"),
});

// Process jobs from a queue
async function processJob(job: Job) {
    const session = await client.createSession({
        sessionId: `job-${job.id}`,
        model: "gpt-5.4",
    });

    const response = await session.sendAndWait({
        prompt: job.prompt,
    });

    await saveResult(job.id, response?.data.content);
    await session.disconnect();  // Clean up after job completes
}
```

### Implementación de Docker Compose

```yaml
version: "3.8"

services:
  copilot-cli:
    image: copilot-cli:latest  # See "Step 1" above for how to build this image
    command: ["--headless", "--host", "0.0.0.0", "--port", "4321"]
    environment:
      - COPILOT_GITHUB_TOKEN=${COPILOT_GITHUB_TOKEN}
    ports:
      - "4321:4321"
    restart: always
    volumes:
      - session-data:/root/.copilot/session-state

  api:
    build: .
    environment:
      - CLI_URL=copilot-cli:4321
    depends_on:
      - copilot-cli
    ports:
      - "3000:3000"

volumes:
  session-data:
```

![Diagrama: Diagrama de flujo que muestra el proceso descrito.](/assets/images/help/copilot/copilot-sdk/setup-backend-services-diagram-4.png)

## Exámenes de salud

Supervise el estado del servidor de la CLI:

```typescript
// Periodic health check
async function checkCLIHealth(): Promise<boolean> {
    try {
        const status = await client.getStatus();
        return status !== undefined;
    } catch {
        return false;
    }
}
```

## Limpieza de sesión

Los servicios back-end deben limpiar activamente las sesiones para evitar pérdidas de recursos:

```typescript
// Clean up expired sessions periodically
async function cleanupSessions(maxAgeMs: number) {
    const sessions = await client.listSessions();
    const now = Date.now();

    for (const session of sessions) {
        const age = now - new Date(session.createdAt).getTime();
        if (age > maxAgeMs) {
            await client.deleteSession(session.sessionId);
        }
    }
}

// Run every hour
setInterval(() => cleanupSessions(24 * 60 * 60 * 1000), 60 * 60 * 1000);
```

## Limitaciones

| Limitación                                                | Detalles                                                                                                                                                  |
| --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Servidor de la CLI único = punto único de error**       | Consulte [Escalabilidad y multitenencia](/es/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/setup/scaling) para los patrones de alta disponibilidad. |
| **Ninguna autenticación integrada entre el SDK y la CLI** | Proteger la ruta de acceso de red (el mismo host, VPC, etc.)                                                                                              |
| **Estado de sesión en el disco local**                    | Montar almacenamiento persistente para los reinicios del contenedor                                                                                       |
| **Tiempo de espera de inactividad de 30 minutos**         | Las sesiones sin actividad se limpian automáticamente                                                                                                     |

## Cuándo seguir adelante

| Requisito                                                                                                                    | Guía siguiente |
| ---------------------------------------------------------------------------------------------------------------------------- | -------------- |
| Varios servidores de la CLI o alta disponibilidad                                                                            |                |
| [Escalabilidad y multitenencia](/es/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/setup/scaling)                       |                |
| Aislamiento del SDK para usuarios simultáneos                                                                                |                |
| [Multiinquilino e implementaciones de servidor](/es/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/setup/multi-tenancy) |                |
| autenticación de cuenta de GitHub para usuarios                                                                              |                |
| [Configuración de OAuth de GitHub](/es/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/setup/github-oauth)               |                |
| Sus propias claves de modelo                                                                                                 |                |
| [BYOK (traiga su propia clave)](/es/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/auth/byok)                           |                |

## Pasos siguientes

* **[Multiinquilino e implementaciones de servidor](/es/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/setup/multi-tenancy)**: Configuración del aislamiento del SDK para usuarios simultáneos
* **[Escalabilidad y multitenencia](/es/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/setup/scaling)**: controlar más usuarios, agregar redundancia
* **[Reanudación y persistencia de sesión](/es/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/features/session-persistence)**: Reanudar sesiones entre reinicios
* **[Configuración de OAuth de GitHub](/es/enterprise-cloud@latest/copilot/how-tos/copilot-sdk/setup/github-oauth)**: Agregar autenticación de usuario