mirror of
https://codeberg.org/icewind/haze.git
synced 2026-06-03 17:14:08 +02:00
112 lines
No EOL
2.1 KiB
Markdown
112 lines
No EOL
2.1 KiB
Markdown
# Haze
|
|
|
|
Hazy with a chance of clouds.
|
|
|
|
## Setup
|
|
|
|
### Requirements
|
|
|
|
- Docker
|
|
|
|
### Config
|
|
|
|
Create a file `~/.config/haze/haze.toml` with the following options:
|
|
|
|
```toml
|
|
sources_root = "/path/to/nextcloud/sources"
|
|
```
|
|
|
|
See the [configuration section](#configuration) for more options.
|
|
|
|
## Managing instances
|
|
|
|
#### Start an instance
|
|
|
|
```bash
|
|
haze start [database] [php-version]
|
|
```
|
|
|
|
Where `database` is one of `sqlite`, `mysql`, `mariadb` or `pgsql` with an optional version (e.g. `pgsql:12`), defaults to `sqlite`.
|
|
And `php-version` is one of `7.2`, `7.3`, `7.4`, `8.0`, `7` or `8`, defaults to `8.0`
|
|
|
|
#### Run tests in a new instance
|
|
|
|
```bash
|
|
haze test [database] [php-version] [path]
|
|
```
|
|
|
|
Where `path` is a file or folder to run phpunit in, relative to the sources root.
|
|
|
|
### List running instances
|
|
|
|
```bash
|
|
haze
|
|
```
|
|
|
|
or
|
|
|
|
```bash
|
|
haze list
|
|
```
|
|
|
|
#### Remove all running instances
|
|
|
|
```bash
|
|
haze clean
|
|
```
|
|
|
|
## Controlling running instances
|
|
|
|
The following commands run against the most recently started instance and allow optionally providing a `match` to select a specific instance by it's name.
|
|
|
|
#### Open an instance
|
|
|
|
```bash
|
|
haze [match] open
|
|
```
|
|
|
|
#### Open the database of an instance
|
|
|
|
```bash
|
|
haze [match] db
|
|
```
|
|
|
|
#### Execute a command on an instance
|
|
|
|
```bash
|
|
haze [match] exec [cmd]
|
|
```
|
|
|
|
If no `cmd` is specified it will launch `bash`
|
|
|
|
#### Execute an occ command on an instance
|
|
|
|
```bash
|
|
haze [match] occ [cmd]
|
|
```
|
|
|
|
#### Show the logs of an instance
|
|
|
|
```bash
|
|
haze [match] logs
|
|
```
|
|
|
|
#### Stop an instance
|
|
|
|
```bash
|
|
haze [match] stop
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Configuration is loaded from `~/.config/haze/haze.toml` and has the following options
|
|
|
|
```toml
|
|
sources_root = "/path/to/sources" # path of the nextcloud sources. required
|
|
work_dir = "/path/to/temp/dir" # path to temporary directory. optional, defaults to "/tmp/haze"
|
|
|
|
[auto_setup] # optional
|
|
enabled = false # whether or not to automatically install nextcloud on `haze start`. optional, defaults to false
|
|
username = "foo" # username for admin user during auto setup. optional, defaults to "admin"
|
|
password = "bar" # password for admin user during auto setup. optional, defaults to "admin"
|
|
``` |