diff --git a/images/docker-openssh-server/index.html b/images/docker-openssh-server/index.html index ee31f2de30..3ca3a4f51d 100644 --- a/images/docker-openssh-server/index.html +++ b/images/docker-openssh-server/index.html @@ -1,4 +1,4 @@ - openssh-server - LinuxServer.io
Skip to content

linuxserver/openssh-server

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI

Openssh-server is a sandboxed environment that allows ssh access without giving keys to the entire server. Giving ssh access via private key often means giving full access to the server. This container creates a limited and sandboxed environment that others can ssh into. The users only have access to the folders mapped and the processes running inside this container.

openssh-server

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/openssh-server:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture Available Tag
x86-64 ✅ amd64-<version tag>
arm64 ✅ arm64v8-<version tag>
armhf ❌

Application Setup

If PUBLIC_KEY or PUBLIC_KEY_FILE, or PUBLIC_KEY_DIR variables are set, the specified keys will automatically be added to authorized_keys. If not, the keys can manually be added to /config/.ssh/authorized_keys and the container should be restarted. Removing PUBLIC_KEY or PUBLIC_KEY_FILE variables from docker run environment variables will not remove the keys from authorized_keys. PUBLIC_KEY_FILE and PUBLIC_KEY_DIR can be used with docker secrets.

We provide the ability to set and allow password based access via the PASSWORD_ACCESS and USER_PASSWORD variables, though we as an organization discourage using password auth for public facing ssh endpoints.

Connect to server via ssh -i /path/to/private/key -p PORT USER_NAME@SERVERIP

Setting SUDO_ACCESS to true by itself will allow passwordless sudo. USER_PASSWORD and USER_PASSWORD_FILE allow setting an optional sudo password.

The users only have access to the folders mapped and the processes running inside this container. Add any volume mappings you like for the users to have access to. To install packages or services for users to access, use the LinuxServer container customization methods described in this blog article.

Sample use case is when a server admin would like to have automated incoming backups from a remote server to the local server, but they might not want all the other admins of the remote server to have full access to the local server. This container can be set up with a mounted folder for incoming backups, and rsync installed via LinuxServer container customization described above, so that the incoming backups can proceed, but remote server and its admins' access would be limited to the backup folder.

It is also possible to run multiple copies of this container with different ports mapped, different folders mounted and access to different private keys for compartmentalized access.

TIPS

You can volume map your own text file to /etc/motd to override the message displayed upon connection. You can optionally set the docker argument hostname

Key Generation

This container has a helper script to generate an ssh private/public key. In order to generate a key please run: 

docker run --rm -it --entrypoint /keygen.sh linuxserver/openssh-server
+ openssh-server - LinuxServer.io       
 
 
  
 
  
 
 
 
 
  
 
 
 
 
 
  
 
 
 
 
   
linuxserver/openssh-server
 
Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI
 
Openssh-server is a sandboxed environment that allows ssh access without giving keys to the entire server. Giving ssh access via private key often means giving full access to the server. This container creates a limited and sandboxed environment that others can ssh into. The users only have access to the folders mapped and the processes running inside this container.
 
openssh-server
 
Supported Architectures
 
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
 
Simply pulling lscr.io/linuxserver/openssh-server:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
 
The architectures supported by this image are:
 
  
 Architecture Available Tag 
   
 x86-64 ✅ amd64-<version tag> 
 
 arm64 ✅ arm64v8-<version tag> 
 
 armhf ❌  
  
 
Application Setup
 
If PUBLIC_KEY or PUBLIC_KEY_FILE, or PUBLIC_KEY_DIR variables are set, the specified keys will automatically be added to authorized_keys. If not, the keys can manually be added to /config/.ssh/authorized_keys and the container should be restarted. Removing PUBLIC_KEY or PUBLIC_KEY_FILE variables from docker run environment variables will not remove the keys from authorized_keys. PUBLIC_KEY_FILE and PUBLIC_KEY_DIR can be used with docker secrets.
 
We provide the ability to set and allow password based access via the PASSWORD_ACCESS and USER_PASSWORD variables, though we as an organization discourage using password auth for public facing ssh endpoints.
 
Connect to server via ssh -i /path/to/private/key -p PORT USER_NAME@SERVERIP
 
Setting SUDO_ACCESS to true by itself will allow passwordless sudo. USER_PASSWORD and USER_PASSWORD_FILE allow setting an optional sudo password.
 
The users only have access to the folders mapped and the processes running inside this container. Add any volume mappings you like for the users to have access to. To install packages or services for users to access, use the LinuxServer container customization methods described in this blog article.
 
Sample use case is when a server admin would like to have automated incoming backups from a remote server to the local server, but they might not want all the other admins of the remote server to have full access to the local server. This container can be set up with a mounted folder for incoming backups, and rsync installed via LinuxServer container customization described above, so that the incoming backups can proceed, but remote server and its admins' access would be limited to the backup folder.
 
It is also possible to run multiple copies of this container with different ports mapped, different folders mounted and access to different private keys for compartmentalized access.
 
TIPS
 
You can volume map your own text file to /etc/motd to override the message displayed upon connection. You can optionally set the docker argument hostname
 
Key Generation
 
This container has a helper script to generate an ssh private/public key. In order to generate a key please run: 
docker run --rm -it --entrypoint /keygen.sh linuxserver/openssh-server
 
 
Then simply follow the prompts. The keys generated by this script are only displayed on your console output, so make sure to save them somewhere after generation.
 
Usage
 
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
  
---
 version: "2.1"
 services:
@@ -72,4 +72,4 @@
   --pull \
   -t lscr.io/linuxserver/openssh-server:latest .
 
 
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
 
docker run --rm --privileged multiarch/qemu-user-static:register --reset
-
 
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
 
Versions
 
     
  • 12.06.23: - Rebase to Alpine 3.18, deprecate armhf. As announced here
    •  
  • 05.03.23: - Rebase to Alpine 3.17.
    •  
  • 18.10.22: - Fix wrong behavior of password/passwordless sudo
    •  
  • 11.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
    •  
  • 15.09.22: - add netcat-openbsd with support for proxies.
    •  
  • 18.07.22: - Fix service perms to comply with upgrade to s6 v3.
    •  
  • 16.04.22: - Rebase to alpine 3.15.
    •  
  • 16.11.21: - Add PUBLIC_KEY_URL option
    •  
  • 28.06.21: - Rebasing to alpine 3.14. Add support for PAM.
    •  
  • 10.02.21: - Rebasing to alpine 3.13. Add openssh-client for scp.
    •  
  • 21.10.20: - Implement s6-log for openssh, which adds local timestamps to logs and can be used with a log parser like fail2ban.
    •  
  • 20.10.20: - Set umask for sftp.
    •  
  • 01.06.20: - Rebasing to alpine 3.12.
    •  
  • 18.01.20: - Add key generation script.
    •  
  • 13.01.20: - Add openssh-sftp-server.
    •  
  • 19.12.19: - Rebasing to alpine 3.11.
    •  
  • 17.10.19: - Initial Release.
    •  
 
 
  Last update: November 1, 2023 
 Created: October 22, 2019  
 
 
 
  
  
 
 
 
      
\ No newline at end of file
+

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

  • 12.06.23: - Rebase to Alpine 3.18, deprecate armhf. As announced here
  • 05.03.23: - Rebase to Alpine 3.17.
  • 18.10.22: - Fix wrong behavior of password/passwordless sudo
  • 11.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
  • 15.09.22: - add netcat-openbsd with support for proxies.
  • 18.07.22: - Fix service perms to comply with upgrade to s6 v3.
  • 16.04.22: - Rebase to alpine 3.15.
  • 16.11.21: - Add PUBLIC_KEY_URL option
  • 28.06.21: - Rebasing to alpine 3.14. Add support for PAM.
  • 10.02.21: - Rebasing to alpine 3.13. Add openssh-client for scp.
  • 21.10.20: - Implement s6-log for openssh, which adds local timestamps to logs and can be used with a log parser like fail2ban.
  • 20.10.20: - Set umask for sftp.
  • 01.06.20: - Rebasing to alpine 3.12.
  • 18.01.20: - Add key generation script.
  • 13.01.20: - Add openssh-sftp-server.
  • 19.12.19: - Rebasing to alpine 3.11.
  • 17.10.19: - Initial Release.
Last update: November 19, 2023
Created: October 22, 2019
\ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz index e0e78ccffb..5794454019 100644 Binary files a/sitemap.xml.gz and b/sitemap.xml.gz differ