docs update
@@ -7,7 +7,7 @@
|
||||
[](https://chv.to/community)
|
||||
[](https://chv.to/discord)
|
||||
|
||||
Dockerfile template project for building and distributing container images for Chevereto (ahead) releases to any container registry. It also works with custom applications.
|
||||
Dockerfile template project for building and distributing container images for Chevereto projects to any container registry.
|
||||
|
||||
## Note
|
||||
|
||||
@@ -15,9 +15,6 @@ Dockerfile template project for building and distributing container images for C
|
||||
|
||||
🧐 Handle it with care or your license details could be stolen.
|
||||
|
||||
## Reference
|
||||
## Documentation
|
||||
|
||||
* [SETUP](SETUP.md)
|
||||
* [BUILDING](BUILDING.md)
|
||||
* [UPDATING](UPDATING.md)
|
||||
* [GUIDES](guides/README.md)
|
||||
* [DOCS](docs/README.md)
|
||||
|
||||
@@ -4,7 +4,7 @@ The build process consist in build the container image that you will use to depl
|
||||
|
||||
## Manual building
|
||||
|
||||
Refer to the [CONSOLE GUIDE](guides/console/BUILDING.md).
|
||||
Refer to the [CONSOLE GUIDE](console/BUILDING.md).
|
||||
|
||||
## GitHub workflow-based building
|
||||
|
||||
@@ -41,3 +41,18 @@ drwxr-xr-x 6 www-data www-data 4096 Jun 23 16:47 importing
|
||||
drwxr-xr-x 4 www-data www-data 4096 Jun 23 15:13 lib
|
||||
drwxr-xr-x 2 www-data www-data 4096 Jun 23 15:13 sdk
|
||||
```
|
||||
|
||||
## Volume reference
|
||||
|
||||
| Volume | Mount path | Purpose |
|
||||
| ----------- | ---------------------- | ------------------------------------ |
|
||||
| chv-storage | /var/www/html/images/ | User uploads |
|
||||
| chv-assets | /var/www/html/_assets/ | Website assets (avatars, logos, etc) |
|
||||
|
||||
### `chv-storage`
|
||||
|
||||
This volume is used to store user uploaded images in the same filesystem where Chevereto is running. This is used when you don't add any External Storage provider to Chevereto.
|
||||
|
||||
### `chv-assets`
|
||||
|
||||
This volume is used to store the Chevereto assets namely user avatars, website logos, background images, etc. This is used when you configure asset storage for use the `local` External Storage API.
|
||||
@@ -1,7 +1,9 @@
|
||||
# Guides
|
||||
# Docs
|
||||
|
||||
For all purposes, the [docker-compose](../docker-compose/) folder contains examples on running using `docker-compose.yml` files.
|
||||
|
||||
* [SETUP](SETUP.md)
|
||||
* [BUILDING](BUILDING.md)
|
||||
* [UPDATING](UPDATING.md)
|
||||
* [PERSISTENT](PERSISTENT.md)
|
||||
* [Portainer](portainer/README.md)
|
||||
* [Console](console/README.md)
|
||||
* [CONSOLE](console/README.md)
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## Manual setup
|
||||
|
||||
Refer to the [CONSOLE GUIDE](guides/console/SETUP.md).
|
||||
Refer to the [CONSOLE GUIDE](console/SETUP.md).
|
||||
|
||||
## GitHub repo setup
|
||||
|
||||
@@ -4,7 +4,7 @@ The update process consist in that you pull our `chevereto/container-builder` re
|
||||
|
||||
## Manual updating
|
||||
|
||||
Refer to the [CONSOLE GUIDE](guides/console/UPDATING.md).
|
||||
Refer to the [CONSOLE GUIDE](console/UPDATING.md).
|
||||
|
||||
## GitHub one-click updating
|
||||
|
||||
@@ -2,14 +2,14 @@
|
||||
|
||||
> Note: Running the command from the top folder of this repository.
|
||||
|
||||
* Change `<license>` with your Chevereto license.
|
||||
* Change `YOUR_V3_LICENSE_KEY` with your Chevereto license.
|
||||
|
||||
* **amd64**
|
||||
|
||||
```sh
|
||||
docker build -t chevereto-build:latest-httpd-php-amd64 . \
|
||||
-f httpd-php.Dockerfile \
|
||||
--build-arg CHEVERETO_LICENSE=<license> \
|
||||
--build-arg CHEVERETO_LICENSE=YOUR_V3_LICENSE_KEY \
|
||||
--build-arg ARCH=amd64
|
||||
```
|
||||
|
||||
@@ -18,6 +18,6 @@ docker build -t chevereto-build:latest-httpd-php-amd64 . \
|
||||
```sh
|
||||
docker build -t chevereto-build:latest-httpd-php-arm64v8 . \
|
||||
-f httpd-php.Dockerfile \
|
||||
--build-arg CHEVERETO_LICENSE=<license> \
|
||||
--build-arg CHEVERETO_LICENSE=YOUR_V3_LICENSE_KEY \
|
||||
--build-arg ARCH=arm64v8
|
||||
```
|
||||
|
Before Width: | Height: | Size: 215 KiB After Width: | Height: | Size: 215 KiB |
|
Before Width: | Height: | Size: 164 KiB After Width: | Height: | Size: 164 KiB |
|
Before Width: | Height: | Size: 129 KiB After Width: | Height: | Size: 129 KiB |
|
Before Width: | Height: | Size: 171 KiB After Width: | Height: | Size: 171 KiB |
|
Before Width: | Height: | Size: 134 KiB After Width: | Height: | Size: 134 KiB |
@@ -1,98 +0,0 @@
|
||||
# Portainer
|
||||
|
||||
## Requirements
|
||||
|
||||
To use Chevereto with [Portainer](https://www.portainer.io/) you need the **Chevereto image build** already made and available in the private container registry of your choice.
|
||||
|
||||
## Installation
|
||||
|
||||
1. Install **Portainer** following the instructions for your system.
|
||||
|
||||
If you are using a remote container registry such as Docker hub and others:
|
||||
|
||||
1. Go to **Registries**
|
||||
2. Add the user credentials for your **container registry**
|
||||
|
||||
## Adding Chevereto as a Portainer custom application
|
||||
|
||||
**NOTE:** [Portainer CE 2.1.1](https://www.portainer.io/blog/portainer-release-2.1.1) supports docker-compose > 3 for standalone hosts **ONLY for amd64** architecture. This guide won't work when using arm64, for which case you can manual run `docker compose` following our [CONSOLE GUIDE](../console/docker-compose.md).
|
||||
|
||||
1. Open Portainer and go to endpoint **Dashboard**
|
||||
2. Go to **App Templates** and then click on **Custom Templates**
|
||||
3. Click on **Add Custom Template**
|
||||
4. Fill the required information
|
||||
1. **Title:** Chevereto
|
||||
2. **Description:** My Chevereto
|
||||
3. **Icon URL:** `https://chevereto.com/src/icons/logo.svg`
|
||||
4. **Platform:** Linux
|
||||
5. **Type:** Standalone
|
||||
5. **Under Build method** select **Web editor** and provide your [docker-compose](#docker-compose) file contents
|
||||
6. Finish by clicking on **Create custom template**
|
||||
|
||||
When done, Chevereto will be available in the custom applications list.
|
||||
|
||||
### docker-compose
|
||||
|
||||
* [httpd-php-amd64.yml](../../docker-compose/httpd-php-amd64.yml)
|
||||
* [httpd-php-arm64v8.yml](../../docker-compose/httpd-php-arm64v8.yml)
|
||||
|
||||
If you want to use a custom image tag or registry change:
|
||||
|
||||
```yml
|
||||
chv-build:
|
||||
image: chevereto-build:latest-httpd-php-amd64
|
||||
```
|
||||
|
||||
To this, where `your_image_here` references your private image tag.
|
||||
|
||||
```yml
|
||||
chv-build:
|
||||
image: your_image_here
|
||||
```
|
||||
|
||||
You may alter the default provisioning to change HTTPS behavior, set a external storage provider for assets, etc. By default this guide only uses local volumes.
|
||||
|
||||
## Deploying
|
||||
|
||||
1. Go to **Custom Templates**, click **Chevereto**
|
||||
2. Choose your deploy options
|
||||
3. Finish by clicking on **Deploy the stack**
|
||||
|
||||
By default, Chevereto will be available at [localhost:8016](http://localhost:8016)
|
||||
|
||||
When deploying for the **first time**, the volumes will be created and you will **require to fix its permissions**.
|
||||
|
||||
* Check [PERSISTENT](../PERSISTENT.md#using-volumes)
|
||||
|
||||
## Updating
|
||||
|
||||
You will need to [update your template](../../UPDATING.md) then [re-create the build](../../BUILDING.md).
|
||||
|
||||
Once the container image gets re-build, you can re-create the container in Portainer:
|
||||
|
||||
1. Go to your `*chv-build-*` container and click on **Recreate**
|
||||
2. Make sure to enable **Pull latest image**
|
||||
|
||||
The container will be re-created with the updated application layer. Data in your volumes will persist.
|
||||
|
||||
## Useful links
|
||||
|
||||
* Chevereto [Environment](https://v3-docs.chevereto.com/setup/system/environment.html)
|
||||
* Chevereto [External Storage](https://v3-docs.chevereto.com/features/integrations/external-storage.html)
|
||||
|
||||
## Volume reference
|
||||
|
||||
In this Portainer guide persisten storage is provided using volumes. This volume reference is just for purposes of this Portainer guide.
|
||||
|
||||
| Volume | Mount path | Purpose |
|
||||
| ----------- | ---------------------- | ------------------------------------ |
|
||||
| chv-storage | /var/www/html/images/ | User uploads |
|
||||
| chv-assets | /var/www/html/_assets/ | Website assets (avatars, logos, etc) |
|
||||
|
||||
### `chv-storage`
|
||||
|
||||
This volume is used to store user uploaded images in the same filesystem where Chevereto is running. This is used when you don't add any External Storage provider to Chevereto.
|
||||
|
||||
### `chv-assets`
|
||||
|
||||
This volume is used to store the Chevereto assets namely user avatars, website logos, background images, etc. This is used when you configure asset storage for use the `local` External Storage API.
|
||||