myos/README.md

70 lines
781 B
Markdown
Raw Normal View History

# yaip - Yet Another Internet Project
2021-02-08 14:52:49 +01:00
Terraform a bunch of ressources to host your projects on Internet.
2022-06-30 23:37:10 +02:00
2021-02-08 14:52:49 +01:00
## Disclaimer
2021-05-16 22:26:45 +02:00
This is work in progress ;)
2021-02-08 14:52:49 +01:00
2022-07-06 23:27:41 +02:00
## Requirements
2022-07-26 21:57:34 +02:00
You need `docker`, `git` and `make`.
2022-07-06 23:27:41 +02:00
2021-02-08 14:52:49 +01:00
## Usage
2022-06-30 23:37:10 +02:00
### Examples
* Install yaip for domain localhost
2022-06-30 23:37:10 +02:00
```shell
$ make install DOMAIN=localhost
2022-06-30 23:37:10 +02:00
```
* Build an iso
2022-06-30 23:37:10 +02:00
```shell
$ make packer-build
2022-06-30 23:37:10 +02:00
```
### Variables
2021-06-12 03:13:01 +02:00
2022-06-30 23:37:10 +02:00
* DRYRUN
2022-11-02 13:42:27 +01:00
Do nothing, show commands instead of executing it.
2022-06-30 23:37:10 +02:00
```shell
$ make install DRYRUN=true
2022-06-30 23:37:10 +02:00
```
* VERBOSE
2022-11-02 13:42:27 +01:00
Show called functions.
2022-06-30 23:37:10 +02:00
```shell
$ make install VERBOSE=true
2022-11-02 13:42:27 +01:00
```
2022-06-30 23:37:10 +02:00
### Debug
* Show debug variables
```shell
$ make debug
```
* Generate self documentation
```shell
$ make doc
```
2021-06-12 03:13:01 +02:00
2022-06-30 23:37:10 +02:00
* Show env args
2021-06-12 03:13:01 +02:00
```shell
2022-06-30 23:37:10 +02:00
$ make print-env_args
2021-06-12 03:13:01 +02:00
```
2021-02-08 14:52:49 +01:00
## Status
2022-07-06 23:27:41 +02:00
Beta software, use it at your own risks.