new: Hister guide - #2019
Draft
comet73 wants to merge 2 commits into
Draft
Conversation
salocinhb
reviewed
Jul 10, 2026
| Prerequisites | ||
| ============= | ||
|
|
||
| You might want to expose Hister under a specific sub domain: |
Member
There was a problem hiding this comment.
Don't mention additional document roots. Keep it simple. Don't use subfolders. Always use the standard document root ~/html. Always assume the document root is empty.
| .. include:: includes/web-backend.rst | ||
|
|
||
| .. note:: | ||
| Uberspace's web backend will handle HTTPS and proxy all requests (including WebSockets) to your Hister service. |
Member
There was a problem hiding this comment.
I'd strike that note. Web Backends are explained in the backends manual article.
|
|
||
| Download the latest Hister binary from the releases_ page and place it in your ``~/bin`` directory: | ||
|
|
||
| [user@stardust ~]$ wget -O ~/bin/hister https://github.com/asciimoo/hister/releases/download/v0.15.0/hister_0.15.0_linux_amd64 |
Member
There was a problem hiding this comment.
this is missing a
.. code-block::
|
|
||
| Create additional users accordingly. | ||
|
|
||
| Security |
Member
There was a problem hiding this comment.
this is not necessary. Files and folders in your home folder are not world-readable by default.
|
|
||
| .. code-block:: console | ||
|
|
||
| [user@stardust ~]$ hister create-config ~/.config/hister/config.yml |
Member
There was a problem hiding this comment.
include (expected) command output
✓ Config file created: /home/isabell/.config/hister/config.yml
|
|
||
| .. code-block:: console | ||
|
|
||
| [isabell@stardust ~]$ hister listen |
Member
There was a problem hiding this comment.
include expected command output
2026-07-10T11:30:52Z | INFO | server/server.go:189 > Starting webserver Address=0.0.0.0:4433 URL=https://isabell.uber.space/ Version="v0.15.0 (6c51924)"
| To run Hister behind Uberspace's native web backend (reverse proxy), you need to: | ||
|
|
||
| - Set Hister to listen on interface ``0.0.0.0:4433`` by editing the entry server/address in ``~/.config/hister/config.yml``. | ||
| - Configure your public domain that you have created above by setting ``server/base_url`` e.g. ``https://hister.user.uber.space``. |
| autostart=true | ||
| autorestart=true | ||
| stopsignal=INT | ||
| startsecs=5 |
Member
There was a problem hiding this comment.
If you're setting up a supervisord-service, make sure to include startsecs=60 in the service definition.
| ------------------------------- | ||
|
|
||
| Now, connect the Uberspace web backend to your running Hister instance | ||
| (use the port configured in your configuration file, like ``4433`` and your configured domain name instead of /): |
Member
There was a problem hiding this comment.
just assume the default.
.. note::
Hister is running on port 4433.
| Usage | ||
| ===== | ||
|
|
||
| Test your setup by visiting your instance in a browser: ``https://hister.user.uber.space``. |
salocinhb
marked this pull request as draft
July 14, 2026 13:40
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Guide for setting up Hister (personal search index).