Skip to content
The Things Stack documentation home
Getting Started Concepts Cloud Enterprise Integrations API Hardware
Getting Started Concepts
Cloud Enterprise
Integrations API Hardware
Get The Things Stack

    Recent searches

      Popular pages

      • Getting Started
      • Adding Gateways
      • Adding Devices
      • Payload Formatters
      • Webhooks
      • Authentication

      No results for “”.

      • Check the spelling, or try fewer or more general words.
      • Ask the community on The Things Network Forum
      • Contact support
      ↑↓ to navigate ↵ to open Esc to close

      Integrations

      • Overview
      • Adding Applications
      • Data Formats
      • Payload Formatters
      • Webhooks
      • Storage Integration
        • Configuration
        • Enable/Disable
        • Retrieve Messages
      • Integrate with popular IoT platforms
      • Other integrations
      • Application Packages
      • Examples
      Enterprise

      Configuration

      Updated 20 January 2025 Edit on GitHub
      Copy page
      • View as MarkdownThis page as plain text
      • Open in ChatGPTAsk questions about this page
      • Open in ClaudeAsk questions about this page

      This section contains instructions for configuring the Storage Integration on The Things Stack Enterprise distributions.

      Note:

      The Storage Integration is already configured on The Things Stack Cloud and The Things Stack Sandbox distributions. To enable and use the integration for specific Applications, follow the instructions in the Enable/Disable and Retrieve Messages sections.

      The Storage Integration requires configuration for the underlying storage provider used, along with a few options for tuning performance and memory usage.

      You can configure PostgreSQL, or any other PostgreSQL-compatible database (e.g. TimescaleDB). A base-line configuration can be found below. Add the following section into your existing ttn-lw-stack.yml configuration file. See Storage Integration Options for more details.

      108
      109
      110
      111
      112
      113
      114
      115
      116
      117
      118
      
        oauth:
          authorize-url: "https://thethings.example.com/oauth/authorize"
          token-url: "https://thethings.example.com/oauth/token"
          logout-url: "https://thethings.example.com/oauth/logout"
          client-id: "console"
          client-secret: "console" # choose or generate a secret
      
      # If Application Server enabled, defaults for "thethings.example.com":
      as:
        # Configuration required for the Storage Integration
        packages:

      Note:

      This will use the same database instance that is used for the Identity Server as well. In production deployments, this should be a different database.

      TimescaleDB Options

      The Storage Integration has special configuration options for TimescaleDB, that are set as flags when the database is initialized:

      • --timescaledb.chunk-time-interval - this configures the chunk time interval. It accepts values in hours, and is set to 168 hours by default.

      • --timescaledb.retention-days - this sets the number of days for the retention policy. It accepts values in days, and is set to 30 days by default.

      • --timescaledb.enable-retention-policy, --timescaledb.enable-retention-policy=false - this enables or disables the retention policy for TimescaleDB. If enabled, data older than the retention-days will be deleted.

      Warning:

      The last configuration option will have immediate effect and delete messages older than the retention-days value.

      Database Setup

      Initialize the configured database with:

      ttn-lw-stack storage-db init
      

      If you are using TimescaleDB, as mentioned in the TimescaleDB Options section above, the following configuration options are also available:

      --timescaledb.chunk-time-interval
      --timescaledb.enable-retention-policy
      --timescaledb.retention-days
      

      If you are using Docker Compose to run The Things Stack (as shown in Installing The Things Stack guide), initialize the configured database with:

      docker compose run --rm stack storage-db init
      

      If everything went well, upon restart, you should be able to see the following log message:

      INFO Initialized Storage Integration          namespace=applicationserver/io/packages/storage provider=postgres
      
      ← Storage Integration Enable/Disable →

      On this page

      • TimescaleDB Options
      • Database Setup

      Sections

      Getting Started

      Concepts

      Cloud

      Enterprise

      Integrations

      API

      Hardware

      Sitemap

      View our Sitemap

      Contributing

      GitHub

      About Us

      The Things Industries

      Privacy Policy

      Cookie settings

      Cookie Settings

      We use cookies to enhance your experience, analyze site traffic and deliver personalized content. Read our Privacy Policy.

      Cookie categories