README.jinja2

# {{trademark}} on Docker

![](https://libs.websoft9.com/common/websott9-cloud-installer.png) 

## Introduction

[English](/README.md) | [简体中文](/README-zh.md)  

This repository is an **Cloud Native solution** powered by [Websoft9](https://www.websoft9.com), it simplifies the complicated installation and initialization process.  

## System Requirements

The following are the minimal [recommended requirements]({{requirements.url}}):

* **OS**: Red Hat, CentOS, Debian, Ubuntu or other's Linux OS
* **Public Cloud**: More than 20+ major Cloud such as AWS, Azure, Google Cloud, Alibaba Cloud, HUAWEIClOUD, Tencent Cloud
* **Private Cloud**: KVM, VMware, VirtualBox, OpenStack
* **ARCH**:  {{requirements.cpu_arch}}
* **RAM**: {{requirements.memory}} GB or more
* **CPU**: {{requirements.cpu}} cores or higher
* **HDD**: at least {{requirements.disk}} GB of free space
* **Swap file**: at least {{requirements.swap}} GB
* **bandwidth**: more fluent experience over 100M  

## QuickStart

### All-in-one Installer

Use SSH to connect your instance and run the automatic installation script below

```
sudo wget -N https://raw.githubusercontent.com/Websoft9/StackHub/main/docker-installer.sh; sudo bash docker-installer.sh -r {{name}}
```
### package install

1.Make package
You can get the  package as following script
```
sudo wget -N https://raw.githubusercontent.com/Websoft9/StackHub/main/docker-installer.sh; sudo bash docker-installer.sh -r {{name}} -p
```

2.Install by package
Copy package to your server, Use SSH to connect your instance and run the automatic installation script below
```
sudo bash install-{{name}}
```

### Manual Installation

#### Preparation

If you have not install Docker and Docker-Compose, refer to the following commands to install it:

```
curl -fsSL https://get.docker.com -o get-docker.sh && sh get-docker.sh
sudo systemctl enable docker
sudo systemctl start docker
alias docker-compose='docker compose'
echo "alias docker-compose='docker compose'" >> /etc/profile.d/docker-compose.sh
source /etc/profile.d/docker-compose.sh
```

#### Install {{trademark}}

We assume that you are already familiar with Docker, and you can modify [docker-compose file]({{compose_file}}) by yourself

```
git clone --depth=1 https://github.com/Websoft9/docker-{{name}}
cd docker-{{name}}
{% if command_extra is defined -%}
{% for cmd in command_extra -%}
{{cmd.cmd}}  
{% endfor -%}  
{% endif -%}
{% if command_comments is defined -%}
{% for comment in command_comments -%}
# {{comment.comment_en}}  
{% endfor -%}  
{% endif -%}
docker network create websoft9 
docker compose  up -d
```

### FAQ

#### Do I need to change the password before docker-compose up?
Yes, you should modify all database password and application password at docker-compose file for production

#### Docker runing failed for the reason that port conflict?
You should modify ports at [docker-compose file](docker-compose-production.yml) and docker-compose again

{% if faqs is defined -%}
{% for faq in faqs -%}
#### {{faq.question_en}}  
{{faq.answer_en}}  
{% endfor -%}  
{% endif -%}


### Usage instructions

You can point your browser to: *`http://Instance's Internet IP:port`*  

The following is the information that may be needed during use

{% if user is defined -%}
#### Credentials

By default, the available users are:

| Username    | Password |
| ------- | -------- |
|  {{user.username}} | {{user.password}}  |

{% endif -%}

{% if services is defined -%}
#### Services and Ports

| Service | Port | Use |  Necessity |
| --- | --- | --- | --- |
{% for service in services -%}
| {{service.name}} | {{service.port}} | {{service.description_en}} | {{service.required}} |
{% endfor -%} 
{% endif -%}

## Documentation

[{{trademark}} Administrator Guide](https://support.websoft9.com/docs/{{name}})

## Enterprise Support

If you want to get our Enterprise Support to ensure high availability of applications, you can subscribe our [{{trademark}} Enterprise Support](https://apps.websoft9.com/{{name}}) 

What you get with a Enterprise Support subscription?

* Knowledge: Answers and guidance from product experts
* Support: Everything you need for technical support, e.g Enable HTTPS, Upgrade guide
* Security: Security services and tools to protect your software