diff --git a/README.md b/README.md index e36769f..3a4f922 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,7 @@ Here are some example snippets to help you get started creating a container. ``` docker create \ --name=openssh-server \ + --hostname=openssh-server `#optional` \ -e PUID=1000 \ -e PGID=1000 \ -e TZ=Europe/London \ @@ -94,6 +95,7 @@ services: openssh-server: image: linuxserver/openssh-server container_name: openssh-server + hostname: openssh-server #optional environment: - PUID=1000 - PGID=1000 @@ -118,6 +120,7 @@ Container images are configured using parameters passed at runtime (such as thos | Parameter | Function | | :----: | --- | +| `--hostname=openssh-server` | Optionally the hostname can be defined. | | `-p 2222` | ssh port | | `-e PUID=1000` | for UserID - see below for explanation | | `-e PGID=1000` | for GroupID - see below for explanation | diff --git a/readme-vars.yml b/readme-vars.yml index 675cf2f..e4d55a9 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -25,6 +25,9 @@ development_versions_items: # container parameters common_param_env_vars_enabled: true param_container_name: "{{ project_name }}" +param_usage_include_hostname: 'optional' #you can set it to 'optional' +param_hostname: "{{ project_name }}" +param_hostname_desc: "Optionally the hostname can be defined." param_usage_include_vols: true param_volumes: - { vol_path: "/config", vol_host_path: "/path/to/appdata/config", desc: "Contains all relevant configuration files." }