Skip to content

factrylabs/historian

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Factry Historian - Docker Compose Quick Start

This repository provides a Docker Compose setup for Factry Historian, allowing you to quickly deploy a Historian server along with PostgreSQL, InfluxDB, and Grafana.

🚀 Quick Setup

If you want to get started as quickly as possible, just run:

git clone https://github.com/factrylabs/historian
cd historian
docker compose up -d

✅ No environment variables needed
✅ Everything runs with default values
✅ Access the services:

🚨 Important: This quick setup uses default passwords and should not be used for production. See the next section for customizing the setup.

🔧 Configuring Factry Historian via the Browser

Once the services are running, open Factry Historian at: 👉 http://localhost:8000

🛠 Setup Steps

  1. Login → Default username: factry, password: password (change immediately).
  2. Activate a License (or start a trial).
  3. Set Up an Organization → Choose a name & configure PostgreSQL access.
  4. Connect to Internal Database → Use for this docker:
    • Host: http://influx:8086
    • Admin User: factry
    • Admin Password: password
  5. Historian Configuration → Ensure correct API & authentication settings.
  6. Finish Setup

📊 Configuring a Time-Series Database

  1. Go to Configuration > Time Series Databases.
  2. Create a database with:
    • Name: historian
    • Admin User: factry
    • Admin Password: password
    • Host: http://influx:8086
    • Database: historian
  3. Click Save & Test.

📡 Installing a Data Collector

  1. Navigate to Collectors in Factry Historian.
  2. Click Create Collector → e.g., OPC-UA Collector.
  3. Click Generate Token and copy it.
  4. Then proceed with the installation of your collector according to the README at https://github.com/factrylabs/collector.
  5. Pass the copied token as API_TOKEN.
  6. Run the collector with:
docker run -d --restart unless-stopped --name factry-collector -e API_TOKEN=<API_TOKEN> -e PRODUCT=opc-ua ghcr.io/factrylabs/collector:latest

Advanced Setup

In the advanced directory, you'll find a more customizable docker compose setup with environment variables for configuration and a cloud-init script to automate the setup in a cloud environment.


❓ Questions?

For help, visit: 📌 Factry Community https://www.reddit.com/r/Factry/

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages