Commit 87d041bb authored by Jens Langhammer's avatar Jens Langhammer

docs: update docs, add kubernetes install instructions

parent 16239dc3
# Upload
## `POST /upload`
Gyazo-compatible upload endpoint. Takes 2 parameters:
......
You might see this error upon downloading the macOS client:
![Screenshot](mac_error.png)
This happens because `Pyazo.app` is modified server-side to embed your server URL. To fix this issue, execute this command in `Terminal.app`:
`xattr -rc Pyazo.app`
\ No newline at end of file
## Kubernetes
The recommended way to deploy pyazo on docker is on Kubernetes. To make installation easier, we provide a helm chart for this.
To install pyazo using helm on kubernetes, run the following:
```
helm repo add beryju.org https://pkg.beryju.org/repository/helm/
helm install beryju.org/pyazo
```
## Pure Docker
Pyazo can be run on pure docker. The image is `docker.pkg.beryju.org/pyazo`. The image needs to be run twice, once for the webserver and once for the background worker. The config file needs to be mounted under `/etc/pyazo/config.yml`. Uploaded files are saved under `/app/media`, which should be mounted as well.
The webserver can be started by running `manage.py web` in the Container. The process will listen on port 8000 for incoming connections.
The background-worker can be started by running `manage.py worker`.
## Pyazo Installation
Pyazo is a python-based application. There are 2 different packages, one for Python 3.5.x and one for Python 3.6.x. To find out what version you have, run this:
```
......
site_name: Pyazo Documentation
theme:
name: 'material'
name: 'readthedocs'
repo_url: "https://git.beryju.org/BeryJu.org/pyazo"
nav:
pages:
- Home: index.md
- Installation:
- Package: install/package.md
- Docker / Kubernetes: install/docker.md
- Configuration:
- Initial Configuration: configuration/initial.md
- Reverse Proxy: configuration/nginx_reverse_proxy.md
- Migration between systems: configuration/migration_between_systems.md
- MSSQL: configuration/mssql.md
- Clients:
- macOS: clients/mac.md
- API:
- Endpoints: api/api_endpoints.md
mkdocs
mkdocs-material
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment