https://github.com/felbinger/adminguide

Linux Server Administrator Guide
https://github.com/felbinger/adminguide

Last synced: 2 months ago
JSON representation

Linux Server Administrator Guide

• Host: GitHub
• URL: https://github.com/felbinger/adminguide
• Owner: felbinger
• Created: 2020-07-31T21:10:22.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-05T14:24:07.000Z (7 months ago)
• Last Synced: 2024-06-05T16:33:09.643Z (7 months ago)
• Language: Shell
• Homepage: https://adminguide.pages.dev
• Size: 3.1 MB
• Stars: 30
• Watchers: 3
• Forks: 10
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Admin Guide

You can find this repository here: [https://adminguide.pages.dev](https://adminguide.pages.dev).

## Contribute

Feel free to open issues / pull requests.  

Please validate that your changes work as intented!  

You can start the mkdocs development server by running:

```bash

sudo ./serve.sh

# or

sudo sh ./serve.sh

```

The http server is then listening on port 8000.  

**Please review every script from the Internet before executing it!**

### Contribution Guidelines

* Web Services are exposed to `[::1]:8000`

* Secret Environment Variables are in an env_file (and not in the `docker-compose.yml` itself, to prevent leaks) with the following format:

  ```shell

  # .servicename.env

  KEY=value

  ```

* environment variables should be in form of a YAML array, not an object:

  ```yaml

  environment:

    - "KEY=value"

  ```

  instead of

  ```yaml

  # WRONG - please don't do this

  environemnt:

    KEY: value

  # WRONG

  ```

* If possible the service should use either mariadb or postgresql.

  If it makes sense, other databases (e.g. sqlite) are also quiet fine.

* YAML arrays should be quoted, regardless which data is stored:

  ```yaml

  volumes:

    - "/srv/service_name/data:/data"

  ports:

    - "[::1]:8000:1234"

  networks:

    - "default"

    - "database"

  ```