Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kivy/kivy-server
Docker configuration for the Kivy server
https://github.com/kivy/kivy-server
docker docker-compose
Last synced: about 1 month ago
JSON representation
Docker configuration for the Kivy server
- Host: GitHub
- URL: https://github.com/kivy/kivy-server
- Owner: kivy
- License: mit
- Created: 2016-10-31T16:35:05.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-08-24T09:16:06.000Z (about 2 years ago)
- Last Synced: 2024-04-14T11:01:22.331Z (7 months ago)
- Topics: docker, docker-compose
- Language: Shell
- Homepage:
- Size: 103 KB
- Stars: 12
- Watchers: 11
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kivy Server
## Quickly deploy changes
```shell
ssh [email protected]
cd ~/docker/kivy-server
git pull
docker-compose build
docker-compose up -d
```
## Usage
These are some of the most common tasks that are performed by maintainers.
You can connect directly to the `downloads` container to maintain
the directory served at https://kivy.org/downloads/.
```shell
ssh -p 2458 [email protected]
cd /web/downloads
```
Connect to the host to manage the server.
```shell
ssh [email protected]
```
Keep the host up to date.
```shell
apt-get update
apt-get dist-upgrade
```
The server repository is located at `~/docker/kivy-server`.
Secrets are kept in the `.env` folder, and they are referenced
by services in `docker-compose.yml` and certain Dockerfiles.
```shell
cd ~/docker/kivy-server
```
Pull changes from GitHub.
```shell
git pull
```
Images and the containers created from them can be referenced
by their service names.
```shell
# list services declared in `docker-compose.yml`
docker-compose config --services
```
Build the images.
```shell
# build new/changed images
docker-compose build
# build all images without using the cache
docker-compose build --no-cache
# build a specific image
docker-compose build nginx
```
Create containers from updated or new images and start all services.
Use this command to deploy changes.
```shell
docker-compose up -d
```
Stop and remove containers and networks.
```shell
docker-compose down
```
Start existing containers.
```shell
docker-compose start
# start a specific container
docker-compose start nginx
```
Stop running containers.
```shell
docker-compose stop
# stop a specific container
docker-compose stop nginx
```
Inspect the logs.
```shell
# list logs for all containers
docker-compose logs
# follow logs for all containers
docker-compose logs -f
# follow logs for a specific container
docker-compose logs -f nginx
# follow logs starting from the last 100 lines
docker-compose logs -f --tail 100 nginx
```
Get a shell in a running container. If `bash` is not available in the container,
use `sh`.
```shell
docker-compose exec docs bash
```
Start, stop and restart the Docker service.
```shell
service docker start
service docker stop
service docker restart
```
Add access for team member (do the following for both `ssh -p 2458 [email protected]` and `ssh [email protected]`)
```shell
# get public ssh key from them (`cat ~/.ssh/id_rsa.pub`)
# open keys in nano
nano ~/.ssh/authorized_keys
# in nano paste their key in a new line (should be something like `ssh-rsa AAAAB...iSTP username@hostname`)
# save in nano and exit
```
Remove access for team member (do the following for both `ssh -p 2458 [email protected]` and `ssh [email protected]`)
```shell
# open keys in nano
nano ~/.ssh/authorized_keys
# locate line with their key, delete it with ctrl-k
# save and exit
```
Add ssh key for CI to push to downloads and use it in the CI
On the download server:
```shell
# access download server
ssh -p 2458 [email protected]
# generate key for the service (e.g. github)
ssh-keygen -t ed25519 -C "kivy-repo@githubci" -q -N ""
# it prompts where to save it, give it unique name
Enter file in which to save the key (/root/.ssh/id_ed25519): /root/.ssh/id_ed25519_kivy_ghci
# copy the key
cat ~/.ssh/id_ed25519_kivy_ghci.pub
# and add it to the host's authorized_keys using nano
nano ~/.ssh/authorized_keys
# save nano
# copy the private key from terminal
cat ~/.ssh/id_ed25519_kivy_ghci
```
Now, go to repo of interest and paste the private key as a secrent variable (e.g. `UBUNTU_UPLOAD_KEY`).
In the yml do:
```yaml
env:
UBUNTU_UPLOAD_KEY: ${{ secrets.UBUNTU_UPLOAD_KEY }}
```
And to use it do:
```shell
printf "%s" "$UBUNTU_UPLOAD_KEY" > ~/.ssh/id_rsa
chmod 600 ~/.ssh/id_rsa
echo -e "Host $1\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
```
## Troubleshoot low disk space
Inspect disk space usage of the host.
```shell
df -h
```
Inspect disk space usage of Docker.
```shell
# overview
docker system df
# verbose
docker system df -v
```
Inspect a folder within a running container.
```shell
docker-compose exec downloads bash
# check directory size
du -h -s /web/downloads
```
#### Clear Docker data
Check out the [docs](https://docs.docker.com/config/pruning/)
to learn more about the commands listed below.
Remove stopped containers.
```shell
docker container prune
```
Remove images that are not used by existing containers.
```shell
docker image prune -a
```
Remove volumes that are not used by existing containers.
**WARNING! Persistent data is stored in volumes.**
```shell
docker volume prune
```
Remove networks that are not used by existing containers.
```shell
docker network prune
```
Shortcut for all of the above.
```shell
docker system prune --volumes
```