Quick Reference
Getting Started
This guide provides the minimal steps to get a Speckle server running quickly. For a complete deployment guide with all configuration options, see Deploying with Docker Compose.
Prerequisites
- Linux VM with at least 4GB RAM
- x86_64 CPU architecture
- Docker and Docker Compose installed
Quick Start
1
Create Directory
2
Create Docker Compose File
Create a file named docker-compose.yml
with the following content:
3
Start the Server
Access Your Server
Once running, access your Speckle server at:
- Frontend:
http://your-server-ip
- MinIO Console:
http://your-server-ip:9001
(credentials:minioadmin
/minioadmin
)
Next Steps
- Create your first user by visiting the frontend URL
- Configure your server - see Deploying with Docker Compose for detailed configuration options
- Set up SSL certificates for production use
- Configure backups and monitoring
Getting Help
- Full Deployment Guide: Deploying with Docker Compose
- Community Forum: speckle.community
- Professional Support: https://speckle.systems/pricing/
Important: This basic setup is not recommended for production use. For production deployments, see the complete Deploying with Docker Compose guide.