Sliplane

https://docs.sliplane.io
Admin
Sliplane is a simple and cost-effective solution for deploying containerized applications with...
Tokens:11,778
Snippets:148
Trust Score:9.3
Update:7 months ago
Show doc for...
Tokens:
Raw
### Dockerfile for NGINX Redirect Service

Source: https://docs.sliplane.io/guides/www-redirect

This Dockerfile sets up a minimal NGINX image. It copies a custom NGINX configuration file into the container, exposes port 80, and starts the NGINX server. This is a foundational step for the redirect service.

```dockerfile
FROM nginx:alpine

COPY nginx.conf /etc/nginx/conf.d/default.conf

EXPOSE 80

CMD ["nginx", "-g", "daemon off;"]
```

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

### Add Sliplane MCP Server using Claude Code

Source: https://docs.sliplane.io/mcp/getting-started

This command-line instruction adds the Sliplane MCP server using Claude Code. It requires the server URL and an API key for authentication. Ensure you replace 'yourapikeyhere' with your actual API key.

```bash
claude mcp add sliplane https://mcp.sliplane.io \
    -t http \
    -H "Authorization: Bearer yourapikeyhere" \

```

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

### Configure Sliplane MCP Server in VS Code

Source: https://docs.sliplane.io/mcp/getting-started

This JSON configuration file, typically placed at `.vscode/mcp.json`, sets up the Sliplane MCP server for Visual Studio Code. It defines the server's URL and the Authorization header, which requires your unique API key for secure access.

```json
{
  "servers": {
    "sliplane": {
      "url": "https://mcp.sliplane.io",
      "headers": {
        "Authorization": "Bearer yourapikeyhere",
      },
    }
  }
}
```

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

### Configure Sliplane MCP Server in Cursor

Source: https://docs.sliplane.io/mcp/getting-started

This JSON configuration is used within Cursor's settings to add the Sliplane MCP server. It specifies the server URL and includes the necessary Authorization header with your API key. This allows Cursor to connect to the Sliplane MCP server.

```json
{
  "mcpServers": {
    "sliplane": {
      "url": "https://mcp.sliplane.io",
      "headers": {
        "Authorization": "Bearer yourapikeyhere",
      }
    }
  }
}
```

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

### NGINX Configuration for Domain Redirect

Source: https://docs.sliplane.io/guides/www-redirect

This NGINX configuration file defines a server block that listens on port 80. It specifies the server name to be redirected (e.g., www.example.com) and uses a `return 301` directive to permanently redirect all requests to the apex domain (e.g., example.com), preserving the original request URI.

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


    location / {
        return 301 https://example.com$request_uri;
    }
}
```

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

### Automate Docker Build and Sliplane Deployment with Github Actions

Source: https://docs.sliplane.io/guides/github-actions

This YAML configuration defines a Github Actions workflow that triggers on pushes to the main branch. It builds a Docker image, pushes it to the Github Container Registry, and sends a deployment request to the Sliplane API using a secure deploy secret.

```yaml
name: Docker Build and Sliplane Deploy

on:
  push:
    branches:
      - main
  workflow_dispatch:

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Login to GitHub Container Registry
        uses: docker/login-action@v3
        with:
          registry: ghcr.io
          username: ${{ github.actor }}
          password: ${{ secrets.GITHUB_TOKEN }}

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3

      - name: Build and push Docker image
        uses: docker/build-push-action@v5
        with:
          context: .
          push: true
          tags: |
            ghcr.io/your-name/your-repo:latest
            ghcr.io/your-name/your-repo:${{ github.sha }}

      - name: Deploy to Sliplane
        run: |
          curl "https://api.sliplane.io/deploy/your-service-id/${{ secrets.DEPLOY_SECRET }}?tag=${{ github.sha }}"
```

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

### Environment Variables for Basic Auth Proxy

Source: https://docs.sliplane.io/guides/basic-auth

These environment variables are required to configure the basic auth proxy service. They define the port, authentication credentials, and the URL of the private service to be secured.

```shell
PORT=8080
HTTP_BASIC_AUTH_USER=yourusername
HTTP_BASIC_AUTH_PASSWORD=yourpassword
PRIVATE_WEBSITE_URL=the-url-of-your-private-service, including protocol and port
```

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

### Connect to SSH Tunnel

Source: https://docs.sliplane.io/guides/ssh

The standard command to initiate an SSH connection to your Sliplane service. It requires the host subdomain and the port provided in the service details.

```bash
ssh root@<your-subdomain>.sliplane.app -p 2222
```

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

### Configure Local Port Forwarding

Source: https://docs.sliplane.io/guides/ssh

Command to forward a local port to a private service port within the Sliplane network. This allows access to internal services as if they were running on localhost.

```bash
ssh -L 8080:<your-app.internal>:<your-app-port> root@<your-subdomain>.sliplane.app -p 2222
```

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

### Retrieve SSH Public Key

Source: https://docs.sliplane.io/guides/ssh

Command to display your local SSH public key, which is required for configuring key-based authentication in the Sliplane environment variables.

```bash
cat ~/.ssh/id_rsa.pub
```
Tokens:
Raw