https://github.com/justintime50/harvey-ui
The UI for the the lightweight Docker Compose deployment platform - Harvey.
https://github.com/justintime50/harvey-ui
ci compose deployment docker frontend harvey system ui
Last synced: 4 months ago
JSON representation
The UI for the the lightweight Docker Compose deployment platform - Harvey.
- Host: GitHub
- URL: https://github.com/justintime50/harvey-ui
- Owner: Justintime50
- License: mit
- Created: 2022-02-15T05:08:29.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-02T03:37:56.000Z (about 1 year ago)
- Last Synced: 2025-05-05T16:54:31.622Z (about 1 year ago)
- Topics: ci, compose, deployment, docker, frontend, harvey, system, ui
- Language: PHP
- Homepage: https://github.com/justintime50/harvey
- Size: 1.79 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Harvey UI
The UI for Harvey, the lightweight Docker Compose deployment runner.
[](https://github.com/Justintime50/harvey-ui/actions)
[](https://coveralls.io/github/Justintime50/harvey-ui?branch=main)
[](https://github.com/justintime50/harvey-ui/releases)
[](LICENSE)
> NOTE: Harvey was used by me for years in production; however, it's a bit rough around the edges still. I eventually had to bite the bullet and switch to Docker Swarm but Harvey remains a viable options for small projects and deployments. I will no longer be actively maintaining the project since I no longer use it daily but welcome any work on the project to smooth over any lingering oddities. A good place to start is the [Harvey Wishlist](https://github.com/Justintime50/harvey/issues/87).
## What is Harvey
[Harvey](https://github.com/Justintime50/harvey) is the lightweight Docker Compose deployment runner. This project serves as a UI on top of the underlying API and service. View your deployment statuses, logs, and runtime history. Lock and unlock deployments as well as redeploy a project with the click of a button.
## Install
```bash
# Copy the env files, and edit as needed
cp src/.env-example src/.env && cp .env-example .env
# Run the setup script which will bootstrap all the requirements, spin up the service, and migrate the database
just setup
```
### Environment Variables
#### Required
- `HARVEY_DOMAIN` (eg: example.com)
#### Optional
- `HARVEY_SECRET` (leave blank if not securing your endpoints)
- `HARVEY_DOMAIN_PROTOCOL` (`http` vs `https` - defaults to `http`)
- `HARVEY_TIMEOUT` (defaults to `10` seconds)
- `HARVEY_PAGE_SIZE` (defaults to `20` records)
## Usage
Visit `harvey.localhost` in a browser to get started.
### Default Login
The default login is `admin@harvey.com` and `password`. **Make sure to update the email/password after first login!**
## Deploy
```bash
# Deploy the project locally
just run
# Deploy the project in production
just prod
```
## Development
```bash
# Get a comprehensive list of development tools
just --list
```