Add initial configuration files for Dockhand setup
- Create .env.example for environment variable configuration - Update README.md with setup instructions and usage details - Add docker-compose configuration for socket-proxy and dockhand services
This commit is contained in:
parent
1854437c46
commit
4459a858e4
3 changed files with 97 additions and 2 deletions
45
README.md
45
README.md
|
|
@ -1,3 +1,44 @@
|
|||
# homeserver
|
||||
# Artemis
|
||||
|
||||
My homeserver
|
||||
My home server
|
||||
|
||||
## Requirements
|
||||
|
||||
```bash
|
||||
# Install docker
|
||||
paru -S docker docker-compose
|
||||
|
||||
# Create the directory on the host
|
||||
sudo mkdir -p /opt/dockhand
|
||||
sudo chown 1000:1000 /opt/dockhand
|
||||
|
||||
# Create 32-byte (256-bit) random key for Dockhand and add it to .env file
|
||||
openssl rand -base64 32
|
||||
|
||||
# Create .env file
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
# Start the containers
|
||||
docker compose up -d
|
||||
|
||||
# Stop the containers
|
||||
docker compose down
|
||||
```
|
||||
|
||||
## Access
|
||||
|
||||
```bash
|
||||
# Open the dashboard in your browser
|
||||
http://localhost:3000
|
||||
|
||||
# Go to Settings > Environments:
|
||||
# - Add a new environment or edit the default one
|
||||
# - Set connection type to Direct
|
||||
# - Set the host to socket:proxy:2375
|
||||
# - Save the environment
|
||||
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue