updating the documentation of the SilverLinux Insftracture
This commit is contained in:
@@ -0,0 +1,153 @@
|
||||
# Portainer
|
||||
|
||||
## Overview
|
||||
|
||||
Portainer provides a web-based management interface for Docker on SilverLinux.
|
||||
|
||||
It is used to manage containers, networks, volumes, images and Docker stacks through a graphical interface instead of using the command line.
|
||||
|
||||
---
|
||||
|
||||
## Service Information
|
||||
|
||||
### URL
|
||||
|
||||
```text
|
||||
https://portainer.silveressence.net
|
||||
```
|
||||
|
||||
### Container Name
|
||||
|
||||
```text
|
||||
portainer
|
||||
```
|
||||
|
||||
### Image
|
||||
|
||||
```text
|
||||
portainer/portainer-ce:latest
|
||||
```
|
||||
|
||||
### Docker Network
|
||||
|
||||
```text
|
||||
proxy
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Purpose
|
||||
|
||||
Portainer is used for:
|
||||
|
||||
* Managing Docker containers
|
||||
* Managing Docker networks
|
||||
* Managing Docker volumes
|
||||
* Viewing logs
|
||||
* Deploying Docker stacks
|
||||
* Monitoring running services
|
||||
* Performing container maintenance
|
||||
|
||||
---
|
||||
|
||||
## Data Storage
|
||||
|
||||
### Docker Socket
|
||||
|
||||
```text
|
||||
/var/run/docker.sock
|
||||
```
|
||||
|
||||
This allows Portainer to communicate with the Docker engine.
|
||||
|
||||
### Portainer Data
|
||||
|
||||
Docker Volume:
|
||||
|
||||
```text
|
||||
portainer_portainer_data
|
||||
```
|
||||
|
||||
Purpose:
|
||||
|
||||
* User accounts
|
||||
* Configuration
|
||||
* Stack definitions
|
||||
* Environment settings
|
||||
|
||||
---
|
||||
|
||||
## Security
|
||||
|
||||
Portainer has administrative access to Docker.
|
||||
|
||||
Because Portainer uses the Docker socket, users with Portainer administrator access effectively have administrative access to the server.
|
||||
|
||||
Only trusted administrators should have access.
|
||||
|
||||
---
|
||||
|
||||
## Backup Requirements
|
||||
|
||||
The following volume should be included in backups:
|
||||
|
||||
```text
|
||||
portainer_portainer_data
|
||||
```
|
||||
|
||||
Loss of this volume will result in:
|
||||
|
||||
* Loss of Portainer users
|
||||
* Loss of stack definitions
|
||||
* Loss of Portainer configuration
|
||||
|
||||
Docker containers and application data remain unaffected.
|
||||
|
||||
---
|
||||
|
||||
## Network Configuration
|
||||
|
||||
Portainer is connected to the Docker proxy network.
|
||||
|
||||
Applications exposed through Nginx Proxy Manager can communicate with Portainer through this network.
|
||||
|
||||
---
|
||||
|
||||
## Maintenance
|
||||
|
||||
View logs:
|
||||
|
||||
```bash
|
||||
docker logs portainer
|
||||
```
|
||||
|
||||
Restart:
|
||||
|
||||
```bash
|
||||
docker restart portainer
|
||||
```
|
||||
|
||||
Open shell:
|
||||
|
||||
```bash
|
||||
docker exec -it portainer /bin/sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Related Services
|
||||
|
||||
* Nginx Proxy Manager
|
||||
* Docker
|
||||
* PostgreSQL
|
||||
* Gitea
|
||||
* OpenProject
|
||||
* Jitsi Meet
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
* docs/server.md
|
||||
* docs/security.md
|
||||
* docs/backups.md
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
services:
|
||||
portainer:
|
||||
image: portainer/portainer-ce:latest
|
||||
container_name: portainer
|
||||
restart: unless-stopped
|
||||
|
||||
volumes:
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
- portainer_data:/data
|
||||
|
||||
networks:
|
||||
- proxy
|
||||
|
||||
volumes:
|
||||
portainer_data:
|
||||
name: portainer_portainer_data
|
||||
|
||||
networks:
|
||||
proxy:
|
||||
external: true
|
||||
Reference in New Issue
Block a user