docs: update docs of README.mds.

summary: update command docker compose to docker-compose.
This commit is contained in:
Mark
2023-01-05 22:29:01 +08:00
parent 20e3e4c434
commit 4b0c67e2aa
40 changed files with 518 additions and 332 deletions

View File

@@ -1,13 +1,17 @@
## Portainer (CE)
This example provides a base setup for using [Portainer](https://www.portainer.io/).
More details on how to customize the installation and the compose file can be found in [portainer documentation](https://documentation.portainer.io/).
### Demo
You can try out the public demo instance first: http://demo.portainer.io/
- username: admin
- password: tryportainer
Project structure:
```
.
├── compose.yaml
@@ -15,24 +19,26 @@ Project structure:
```
[_compose.yaml_](compose.yaml)
``` yaml
```yaml
services:
portainer:
image: portainer/portainer-ce:alpine
```
## Deploy with docker compose
When deploying this setup, the web interface will be available on port 9000 (e.g. http://localhost:9000).
``` shell
$ docker compose up -d
```shell
$ docker-compose up -d
Starting portainer ... done
```
## Expected result
Check containers are running:
```
$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
@@ -42,15 +48,16 @@ CONTAINER ID IMAGE COMMAND CREATED
Navigate to `http://localhost:9000` in your web browser to access the portainer web interface and create an account.
Stop the containers with
``` shell
$ docker compose down
```shell
$ docker-compose down
# To delete all data run:
$ docker compose down -v
$ docker-compose down -v
```
## Troubleshooting
- Select the correct image for your OS. You can take a look at the published tags at [DockerHub](https://hub.docker.com/r/portainer/portainer-ce/tags)
> e.g. currently, the latest tag is for Windows (amd64) and alpine for Linux (amd64, arm/v7)
> e.g. currently, the latest tag is for Windows (amd64) and alpine for Linux (amd64, arm/v7)