linuxserver/hishtory-server
hiSHtory is a better shell history. It stores your shell history in context (what directory you ran the command in, whether it succeeded or failed, how long it took, etc). This is all stored locally and end-to-end encrypted for syncing to to all your other computers.
Simply pulling
lscr.io/linuxserver/hishtory-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 | ❌ | |
This container requires an external postgres database.
After you have installed hishtory on your machine, add
export HISHTORY_SERVER=http://1.2.3.4:8080 (with your server details) to your shellrc. Then run hishtory init (or hishtory init ${SECRET_KEY}) to initialise hishtory against your local server.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:
hishtory-server:
image: lscr.io/linuxserver/hishtory-server:latest
container_name: hishtory-server
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- HISHTORY_POSTGRES_DB=postgresql://${HISHTORY_DB_USER}:${HISHTORY_DB_PASS}@hishtory-db:5432/hishtory?sslmode=disable
ports:
- 8080:8080
restart: unless-stopped
docker run -d \
--name=hishtory-server \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-e HISHTORY_POSTGRES_DB=postgresql://${HISHTORY_DB_USER}:${HISHTORY_DB_PASS}@hishtory-db:5432/hishtory?sslmode=disable \
-p 8080:8080 \
--restart unless-stopped \
lscr.io/linuxserver/hishtory-server:latest
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate
<external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.Parameter | Function |
|---|---|
8080 | API port |
Env | Function |
|---|---|
PUID=1000 | for UserID - see below for explanation |
PGID=1000 | for GroupID - see below for explanation |
TZ=Etc/UTC | |
HISHTORY_POSTGRES_DB=postgresql://${HISHTORY_DB_USER}:${HISHTORY_DB_PASS}@hishtory-db:5432/hishtory?sslmode=disable |
You can set any environment variable from a file by using a special prepend
FILE__.As an example:
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Will set the environment variable
PASSWORD based on the contents of the /run/secrets/mysecretpassword file.For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional
-e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.When using volumes (
-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance
PUID=1000 and PGID=1000, to find yours use id user as below: $ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
- Shell access whilst the container is running:
docker exec -it hishtory-server /bin/bash
- To monitor the logs of the container in realtime:
docker logs -f hishtory-server
- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' hishtory-server
- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/hishtory-server:latest
- 19.05.23: - Initial Release.
Last modified 3mo ago