Dockery/Docker-Chevereto
1
0
Fork 0
mirror of https://github.com/chevereto/docker.git synced 2026-08-05 19:30:04 +02:00
Code Issues Packages Projects Releases Activity

improve docs

Browse Source
This commit is contained in:
Rodolfo Berrios
2024-05-08 17:15:06 -04:00
parent ed08707c3a
commit 455a7326e6
3 changed files with 71 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -63,28 +63,28 @@ make image
To deploy a new website use the following command format.
```sh
make deploy NAMESPACE={namespace} ADMIN_EMAIL={email}
make deploy NAMESPACE=yourproject ADMIN_EMAIL=admin@domain.tld
```
Replace `{namespace}` with the desired project name and `{email}` with the admin email for the website.
Replace `yourproject` with the desired project name and `admin@domain.tld` with the admin email for the website.
### Destroying websites
To destroy a website use the following command format.
```sh
make destroy NAMESPACE={namespace}
make destroy NAMESPACE=yourproject
```
Replace `{namespace}` with the desired project name to destroy.
Replace `yourproject` with the desired project name to destroy.
### Altering existing websites
To alter a website edit `./namespace/{namespace}` to reflect the new variables and run the following commands.
To alter a website edit `./namespace/yourproject` to reflect the new variables and run the following commands.
```sh
make down NAMESPACE={namespace}
make up-d NAMESPACE={namespace}
make down NAMESPACE=yourproject
make up-d NAMESPACE=yourproject
```
## Pure Docker
@@ -174,6 +174,7 @@ make namespace NAMESPACE=yourproject HOSTNAME=yourdomain.tld
* [PURE-DOCKER](./docs/PURE-DOCKER.md)
* [FEEDBACK](./docs/FEEDBACK.md)
* [BUILDING](./docs/BUILDING.md)
* [COMMANDS](./docs/COMMANDS.md)
* [DOCKER-COMPOSE](./docs/DOCKER-COMPOSE.md)
* [VOLUMES](./docs/VOLUMES.md)
* [PERSISTENT](./docs/PERSISTENT.md)

63
docs/COMMANDS.md Normal file
View File

@@ -0,0 +1,63 @@
# Commands
## Instances
## Deploy
Use this when needing to deploy a brand new instance. It will create the NAMESPACE and run CloudFlare related commands (if needed).
```sh
make deploy NAMESPACE=yourproject ADMIN_EMAIL=admin@domain.tld
```
## Update
Use this to update all instances to a newly tagged image.
```sh
make update
```
## Install
Use this to install Chevereto from the command line.
```sh
make install NAMESPACE=yourproject ADMIN_USER=admin ADMIN_EMAIL=admin@domain.tld ADMIN_PASSWORD=mypassword
```
## Destroy
Use this when needing to destroy an instance.
This will run [cloudflare--delete](CLOUDFLARE.md#delete-cname-record), [down--volumes](DOCKER-COMPOSE.md#down-volumes) and remove the [NAMESPACE](NAMESPACE.md).
```sh
make destroy NAMESPACE=yourproject
```
## Proxy
### Proxy create
Run this command to create the ingress proxy, which will create the network and containers.
```sh
make proxy
```
### Proxy view
Run this command to view the ingress proxy configuration.
```sh
make proxy--view
```
### Proxy remove
Run this command if you need to destroy the ingress proxy, which will remove the network and containers.
```sh
make proxy--remove
```

12
docs/DOCKER-COMPOSE.md
View File

@@ -95,18 +95,6 @@ make down
make down--volumes
```
## Combined commands
### Destroy
💡 Use it when needing to complety destroy an instance.
This will run [cloudflare--delete](CLOUDFLARE.md#delete-cname-record), [down--volumes](DOCKER-COMPOSE.md#down-volumes) and remove the [NAMESPACE](NAMESPACE.md).
```sh
make destroy NAMESPACE=yourproject
```
## Troubleshoot
Check if you are running latest Docker version with [Compose V2](https://docs.docker.com/compose/cli-command/) `docker compose` (not `docker-compose`).