Thomas
229bd4b3ed
* feat: migrate tooling and runtimes to bun * fix: serialize act installs and adapt backup checks * fix: finish bun scripts and rootless act setup * fix: support bun images in runtime benchmarks * fix: keep a single bun toolchain configuration * fix: include docs mascot sources in workshop build * docs: use bun in remaining tool commands * fix: complete bun sqlite development tooling * docs: explain sqlite development adapter * fix: align remaining commands and local ci validation * fix: use renovate regex fallback with bun * fix: finalize bun sqlite connections during cleanup * fix: preserve sqlite foreign key enforcement * fix: align docker build frontends * fix: prepare release versions with bun * Add Bun benchmarks and preserve SQLite connection defaults * Benchmark Bun installs, conflicts and production workloads * Force Bun workspace tools and HTTP/1.1 upstream streaming * Exclude benchmark evidence from Docker contexts * Expose branch benchmarks through CI * Verify hydrated widget data in production benchmarks * Measure image archives and document benchmark protocol * Audit dependency sharing across every workspace * Pin pnpm for nested baseline benchmark scripts * Preserve nested manager pinning on benchmark resume * Include application and runtime image footprints * Fail benchmark gates on candidate command errors * Report complete build overhead and sampled memory bounds * Validate migration comparisons across pinned revisions * Record configurable runtime memory budgets * Retain out-of-memory kills in runtime budget probes * Reject OOM events consistently across runtime metrics * Record complete Bun migration benchmarks * Record memory diagnosis and correct Turbo caching * Use Bun package management while preserving Node runtimes * Keep native build fallbacks and exclude development artifacts * Fix Node ESM metadata and isolate local CI configuration * Measure development performance and isolate act environment * Support isolated environment files in rootless act * Validate the full migration range with act * Preserve native SQLite binding for bundled migrations * Use documented dev defaults and report benchmark scope * Validate dev defaults and isolate restart measurements * Record package-manager and development benchmarks * Keep benchmark measurements and link full command artifacts * Clean up temporary act environment files * Validate Node runtimes in package-manager comparisons * Validate every workspace in manual CI runs * Retain patched nested brace expansion versions * Complete package-manager and Node performance report * Normalize archived benchmark logs * Record final hosted validation * Cache both Next builds with platform isolation * Prime cache with write-only mode * Split Next artifacts below Cloudflare upload limit * Assemble coherent standalone cache outputs * Preserve traced middleware entrypoints * Assemble traced directory links before files * Separate cached dependencies from assembled output * Record signed Turbo cache benchmarks * Remove archived benchmark captures Full benchmark evidence is preserved at 8f7d3bcd14109bfb13fa664d31710b88d820ad66. * Remove migration benchmark harness * fix: correct migration launch and local Act prerequisites * Consolidate Turbo caches and production artifacts * Exclude generated files from Docker cache inputs * fix: address Bun migration review findings * fix: check restored compiler bundle manifests
55 lines
1.7 KiB
Plaintext
55 lines
1.7 KiB
Plaintext
---
|
|
title: From source
|
|
---
|
|
|
|
# (Not recommended): From source
|
|
|
|
<Alert type="caution">
|
|
|
|
Installing from source is a bad idea in many ways:
|
|
|
|
- No isolation between applications
|
|
- Dependency conflicts on your root operating system
|
|
- Cumbersome update process
|
|
- Permission management
|
|
- Handling of conflicts
|
|
|
|
Therefore, we highly discourage you from using this as a normal user.
|
|
This method is only useful, when you want to develop on Homarr or extend it with your own functionality.
|
|
|
|
</Alert>
|
|
|
|
## Prerequisites
|
|
|
|
- [Node.js](https://nodejs.org/) 24.18.0 for the application runtime
|
|
- [Bun](https://bun.sh/docs/installation) 1.4.2 (the version pinned in `mise.toml`)
|
|
- [Redis](https://redis.io/download)
|
|
|
|
## Steps
|
|
|
|
<ol>
|
|
<li>
|
|
Clone the Repository using <code>git clone https://github.com/homarr-labs/homarr.git</code>
|
|
</li>
|
|
<li>
|
|
Enter the created directory using <code>cd homarr</code>
|
|
</li>
|
|
<li>
|
|
Install all dependencies using <code>bun install</code>
|
|
</li>
|
|
<li>
|
|
Copy `.env.example` to `.env` and set `DB_URL` to an absolute writable path, such as
|
|
`DB_URL='/home/username/homarr/db.sqlite'`. Migration and application commands run from different workspace
|
|
directories, so a relative path can point them at different databases.
|
|
</li>
|
|
<li>
|
|
Run `openssl rand -hex 32` twice and set `AUTH_SECRET` and `SECRET_ENCRYPTION_KEY` to the two different generated
|
|
values. Keep both values secret and preserve `SECRET_ENCRYPTION_KEY` with your backups.
|
|
</li>
|
|
<li>Run `bun run db:migration:sqlite:run` and wait that it completes</li>
|
|
<li>Build the source using `bun run build`</li>
|
|
<li>Start a redis server using `redis-server`</li>
|
|
<li>Run the server using `bun run start`</li>
|
|
<li>Open `http://localhost:3000` in your browser</li>
|
|
</ol>
|