Getting Started

Get your own Logstyx instance up and running in minutes. This guide will walk you through the installation process and help you send your first logs.

Prerequisites

Before installing Logstyx, make sure you have:

• Docker (version 20.10 or higher) - Install Docker
• Docker Compose (version 2.0 or higher) - Usually included with Docker Desktop
• Bash shell (Linux, macOS, or WSL on Windows)
• OpenSSL (for generating encryption keys) - Usually pre-installed

Verify Installation

Check if Docker and Docker Compose are installed:

docker --version
docker compose version

Quick Installation

The easiest way to get started is using our automated installer:

curl -fsSL https://raw.githubusercontent.com/devatlogstyx/logstyx/main/install.sh | bash

The installer will guide you through the setup process.

Installation Steps

1. Choose Deployment Type

When you run the installer, you'll be asked to choose between two deployment options:

Option 1: Bundled Services (Recommended)

• Logstyx will set up MongoDB, Redis, and RabbitMQ for you
• Everything runs in Docker containers
• Perfect for getting started quickly
• Ideal for small to medium deployments

Option 2: External Services

• Connect to your existing MongoDB, Redis, and RabbitMQ instances
• Useful if you already have these services running
• Better for production environments with existing infrastructure
• Requires you to provide connection URLs

Do you want to:
  1) Use bundled services (Redis, MongoDB, RabbitMQ) - Recommended
  2) Connect to external services

Choice [1]:

2. Configure External Services (Optional)

If you chose Option 2, you'll need to provide connection URLs for:

RabbitMQ URL (e.g., amqp://user:pass@host:5672): amqp://admin:password@rabbitmq.example.com:5672
Redis URL (e.g., redis://host:6379): redis://redis.example.com:6379
MongoDB URL (e.g., mongodb://host:27017): mongodb://mongo.example.com:27017

Connection URLs

Make sure your external services are accessible from where Logstyx will be running. Test connectivity before proceeding.

3. Set Up Admin Account

Provide details for your initial administrator account:

Enter admin username: admin
Enter admin email: admin@example.com
Enter admin password: ********
Enter project title (default: My Logstyx Project): My Company Logs

Security First

• Use a strong password (minimum 12 characters recommended)
• Store these credentials securely - you'll need them to log in
• The password will be encrypted before being stored

4. Automatic Configuration

The installer will automatically:

✅ Generate secure encryption keys (32-character secrets)
✅ Create a MASTER_KEY for encrypting your credentials
✅ Encrypt all sensitive values using AES-256-CTR encryption
✅ Save everything to .env.encrypted
✅ Download required Docker Compose files (if not present)

Generating security secrets...
✓ Secrets generated

Encrypting credentials...
✓ Configuration encrypted and saved

5. Start Services

The installer will ask if you want to start Logstyx immediately:

Start Logstyx now? (Y/n): Y

If you choose Y, the installer will:

• Pull necessary Docker images
• Start all services
• Set up the database
• Initialize your admin account

Starting Logstyx services...

✓ Docker and Docker Compose detected
✓ Logstyx is starting up!

Wait a moment for services to initialize, then access:
http://localhost:5000

Post-Installation

Verify Installation

1. Wait 30-60 seconds for all services to fully initialize
2. Open your browser and navigate to http://localhost:5000
3. Log in with the credentials you provided during installation

First Login

Email: admin@example.com
Password: [the password you set]

After logging in, you'll see the Logstyx dashboard where you can:

• Create your first project
• Generate API keys
• View documentation
• Configure settings

What Gets Installed?

After installation, you'll have these services running:

Service	Port	Description
Gateway	5000	API gateway along with Web interface
Auth Service	5001	Authentication
Cache Service	5002	Caching layer
Utility Service	5003	Utilities
Core Service	5004	Log processing
MongoDB	27017	Database (if bundled)
Redis	6379	Cache (if bundled)
RabbitMQ	5672, 15672	Message queue (if bundled)

Managing Your Installation

View Service Status

docker compose ps

View Logs

# All services
docker compose logs -f

# Specific service
docker compose logs -f core-service

Stop Services

docker compose down

Restart Services

docker compose restart

Update to Latest Version

docker compose pull
docker compose up -d

Configuration Files

After installation, you'll have these files:

.
├── .env.encrypted          # Your encrypted configuration (KEEP THIS SECURE!)
├── docker-compose.yml      # Service definitions
└── docker-compose.prod.yml # Production overrides

Important

NEVER commit .env.encrypted to version control!

Since this file contains your MASTER_KEY which can decrypt all your credentials. Store it securely and remove from the server until you have the need to rebuild the instance.

Next Steps

Now that Logstyx is running, you're ready to:

1. Create Your First Project - Set up a project to organize your logs
2. Install an SDK - Choose the SDK for your platform
3. Configure Probestyx - Add metrics collection (optional)

Troubleshooting

Services Won't Start

# Check Docker is running
docker info

# Check for port conflicts
netstat -tuln | grep -E '5000|27017|6379|5672'

# View error logs
docker compose logs

Can't Access Frontend

• Make sure you waited 30-60 seconds for services to initialize
• Check if port 5000 is available: lsof -i :5000
• Verify services are running: docker compose ps
• Check firewall settings

Login Not Working

• Verify you're using the correct email and password
• Check auth-service logs: docker compose logs auth-service
• Ensure MongoDB is running: docker compose ps mongodb

Need to Reset Everything

# Stop and remove all containers, networks, and volumes
docker compose down -v

# Re-run the installer
curl -fsSL https://raw.githubusercontent.com/devatlogstyx/logstyx/main/install.sh | bash

Important

This generate a new CRYPTO_SECRET and MASTER_KEY which can render all your previous logs undecipherable.

Getting Help

If you run into issues:

• Check the logs: docker compose logs -f
• GitHub Issues: Report a bug
• Discussions: Ask the community
• Documentation: Browse other guides in this documentation