Outline

This Helm chart deploys Outline, a modern team knowledge base and wiki platform, on Kubernetes. Outline provides a beautiful, real-time collaborative editing experience with features like rich text editing, markdown support, and team collaboration tools.

Prerequisites

• Kubernetes 1.19+
• Helm 3.0+
• kubectl configured to communicate with your cluster
• PostgreSQL database (automatically installed as a dependency)
• Redis instance (automatically installed as a dependency)

Dependencies

Before installing the chart, you need to download the required dependencies. Run the following command in the chart directory:

helm dependency build

This command will:

1. Read the dependencies from Chart.yaml
2. Download the required charts (PostgreSQL, Redis, and Service) from the specified repositories
3. Store them in the charts/ directory
4. Create or update the Chart.lock file with the exact versions

If you encounter any issues with the dependencies, you can try:

helm dependency update  # Updates dependencies to the latest versions

This chart requires the following dependencies to be installed:

PostgreSQL

• Chart: postgres
• Version: 0.0.11
• Repository: https://helm.zop.dev
• Purpose: Provides the primary database for Outline’s content and user data

Redis

• Chart: redis
• Version: 0.0.1
• Repository: https://helm.zop.dev
• Purpose: Used for caching and real-time collaboration features

Service

• Chart: service
• Version: 0.0.17
• Repository: https://helm.zop.dev
• Purpose: Manages the Outline application deployment and service configuration

To install these dependencies automatically, ensure the following in your values.yaml:

postgres:
  enabled: true
  # Additional PostgreSQL configuration...

redis:
  enabled: true
  # Additional Redis configuration...

service:
  enabled: true
  # Additional service configuration...

The dependencies will be automatically installed when you deploy the Outline chart. You can customize their configuration through the respective sections in your values.yaml file.

Add Helm Repository

Add the Helm repository by running:

helm repo add zopdev https://helm.zop.dev
helm repo update

For more details, see the Helm Repository Documentation.

Install Helm Chart

To deploy the Outline Helm chart, use the following command:

helm install outline zopdev/outline

The release name must be outline for the chart to install properly.

You can override default values during installation by providing a values.yaml file.

Refer to the Helm Install Documentation for further details.

Uninstall Helm Chart

To remove the Outline Helm chart and associated resources, run:

helm uninstall outline

Check the Helm Uninstall Documentation for more information.

Configuration

The Outline Helm chart includes several configuration options to tailor the deployment to your needs. Below is a summary of the key configurations:

Service Configuration

Environment Configuration

Database Configuration

Health Check Configuration

Example values.yaml

service:
  name: outline
  image: outlinewiki/outline
  minCPU: "250m"
  minMemory: "1000Mi"
  maxCPU: "500m"
  maxMemory: "1500Mi"
  minReplicas: 1

  env:
    SECRET_KEY: ""
    UTILS_SECRET: ""
    FILE_STORAGE: "local"
    FORCE_HTTPS: false
    PGSSLMODE: "disable"
    PORT: 3000
    FILE_STORAGE_LOCAL_ROOT_DIR: "/data"

postgres:
  services:
    - name: "outline"
      database: "outline"

redis:
  services:
    - name: "outline"
      database: "outline"

Features

• Deploys Outline wiki platform with all dependencies
• Automatic PostgreSQL database setup
• Redis integration for caching and real-time features
• Configurable resource limits and requests
• Health monitoring with liveness and readiness probes
• Local file storage support
• HTTPS support
• Customizable environment variables
• Automatic database migrations
• Persistent storage for file uploads

Architecture

The Outline deployment includes:

• Outline application pods
• PostgreSQL database (dependency)
• Redis instance (dependency)
• Persistent volume for file storage
• Health check endpoints
• Ingress configuration for external access
• Environment variable configuration
• Database connection management

Security Features

• Configurable secret keys for encryption
• HTTPS support
• Database SSL configuration
• Health check monitoring
• Resource limits and requests
• Secure environment variable handling

Contributing

We welcome contributions to improve this Helm chart. Please refer to the CONTRIBUTING.md file for contribution guidelines.

Code of Conduct

To maintain a healthy and collaborative community, please adhere to our Code of Conduct.

License

This project is licensed under the LICENSE. Please review it for terms of use.