Architecture
Prerequisites
- Docker and Docker Compose
- A GitHub account (or GitHub Enterprise Server)
- A repository to track
- TLS termination (reverse proxy) for production
Installation
Enterprise customers receive deployment artifacts from LaneSync support. Contact support@lanesync.dev for your installation package and credentials. Typical self-hosted layout:
Production deployments should replace localhost with your internal or public domain behind HTTPS.
First-run setup
1
Open the setup wizard
Navigate to your dashboard URL. The wizard guides GitHub App creation (full or minimal tier).
2
Install the GitHub App
Install on your org or account with required repository access.
3
Configure OAuth
Set GitHub OAuth credentials in
.env or via the setup API. For pre-created apps:4
Sign in and bootstrap repos
Complete OAuth sign-in. Run the repo setup wizard for each tracked repository.
Environment variables
Copy from.env.example. Key variables:
See internal deployment docs in the repository
docs/ folder for cloud-specific variants (AWS, Alibaba).
CI integration
Bootstrapped workflows default:SDLC_API_URL to your API base URL (e.g. https://lanesync.internal.example.com).
Evidence upload and deploy gate checks must reach your instance from GitHub Actions runners.
Advance your first release
Same stage gates as hosted SaaS:- Create milestone with issues
- PLANNING → assign issues
- DEVELOPMENT → merge PRs, cut release branch
- TESTING → CI passes on release branch
- EVIDENCING → approve evidence PR
- DEPLOYMENT → promote to production
Upgrades
- Pull latest image or rebuild
docker-compose up -d --build - Run database migrations (automatic on backend startup)
- Verify
/api/health