Fix up documentation
This commit is contained in:
@@ -46,7 +46,9 @@ If your host is already running X, you can just use that. To do this, be sure to
|
|||||||
|
|
||||||
---
|
---
|
||||||
## Installation:
|
## Installation:
|
||||||
|
- [Docker Compose](./docs/docker-compose.md)
|
||||||
- [Unraid](./docs/unraid.md)
|
- [Unraid](./docs/unraid.md)
|
||||||
|
- [Ubuntu Server](./docs/ubuntu-server.md)
|
||||||
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -1,18 +1,21 @@
|
|||||||
# Unraid
|
# Docker Compose
|
||||||
|
|
||||||
Follow these instructions to configure a docker-compose.yml for your system.
|
Follow these instructions to configure a docker-compose.yml for your system.
|
||||||
|
|
||||||
> __Note__
|
> __Note__
|
||||||
>
|
>
|
||||||
> These instructions assume that you have docker and docker-compose installed for your system.
|
> These instructions assume that you have docker and docker-compose installed for your system.
|
||||||
|
>
|
||||||
> Depending on how you have installed this, the commands to execute docker compose may vary.
|
> Depending on how you have installed this, the commands to execute docker compose may vary.
|
||||||
|
|
||||||
|
|
||||||
## PREPARE DIRECTORY:
|
## PREPARE DIRECTORY:
|
||||||
|
|
||||||
> __Note__
|
> __Warning__
|
||||||
>
|
>
|
||||||
> These commands are ment to be run as your user. Do not run them as root. If you do you should manually fix the permissions and ownership after.
|
> These commands are meant to be run as your user. Do not run them as root.
|
||||||
|
>
|
||||||
|
> If you do run these commands as root, you may need to manually fix the permissions and ownership after.
|
||||||
|
|
||||||
Create a directory for your service:
|
Create a directory for your service:
|
||||||
```
|
```
|
||||||
@@ -26,23 +29,13 @@ sudo mkdir -p /opt/container-data/steam-headless/{home,.X11-unix,pulse}
|
|||||||
sudo chown -R $(id -u):$(id -g) /opt/container-data/steam-headless
|
sudo chown -R $(id -u):$(id -g) /opt/container-data/steam-headless
|
||||||
```
|
```
|
||||||
|
|
||||||
Create a Steam Headless docker-compose.yml file:
|
Create a Steam Headless `/opt/container-services/steam-headless/docker-compose.yml` file.
|
||||||
```
|
|
||||||
touch /opt/container-services/steam-headless/docker-compose.yml
|
|
||||||
```
|
|
||||||
|
|
||||||
Select from the [COMPOSE FILES](#compose-files) list below the link that best describes your hardware.
|
Populate this file with the contents of the default [Docker Compose File](./compose-files/docker-compose.default.yml).
|
||||||
|
|
||||||
Copy the contents of this file to `/opt/container-services/steam-headless/docker-compose.yml`
|
|
||||||
|
|
||||||
|
|
||||||
## CONFIGURE ENV:
|
## CONFIGURE ENV:
|
||||||
|
|
||||||
Create a Steam Headless `/opt/container-services/steam-headless/.env` file with the contents found in this example [Env File](./compose-files/.env).
|
Create a Steam Headless `/opt/container-services/steam-headless/.env` file with the contents found in this example [Environment File](./compose-files/.env).
|
||||||
|
|
||||||
Edit these variables as requied.
|
Edit these variables as required.
|
||||||
|
|
||||||
|
|
||||||
## COMPOSE FILES:
|
|
||||||
|
|
||||||
- [Intel CPU only](../docker-compose.intel.yml)
|
|
||||||
|
|||||||
@@ -1,10 +1,12 @@
|
|||||||
# Unraid
|
# Ubuntu Server
|
||||||
|
|
||||||
Follow these instructions to install Steam Headless on Ubuntu Server.
|
Follow these instructions to install Steam Headless on Ubuntu Server.
|
||||||
|
|
||||||
> __Note__
|
> __Note__
|
||||||
>
|
>
|
||||||
> This assumes that your Ubuntu Server has not be configured to run any desktop environment!
|
> This assumes that your Ubuntu Server has not be configured to run any desktop environment!
|
||||||
|
>
|
||||||
|
> This will not work with Ubuntu Desktop.
|
||||||
|
|
||||||
|
|
||||||
## INSTALL DOCKER:
|
## INSTALL DOCKER:
|
||||||
|
|||||||
Reference in New Issue
Block a user