From 705fe216c7251a73d61fd3e3fa2f707409ebffd6 Mon Sep 17 00:00:00 2001 From: Maxim Burgerhout Date: Sat, 24 Feb 2024 17:48:51 +0100 Subject: [PATCH] Update docs to reflect new features --- CHANGELOG.md | 17 ++++++++++++++++- roles/atuin_client/README.md | 5 ++++- roles/atuin_server/README.md | 4 ++-- 3 files changed, 22 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 35ffa46..3fe1fa7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,8 +5,23 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [2.0.0] + +#### Added + +- Iterate over list of users and build a configuration file for them +- Drop podman molecule scenario in favor of docker for now + +#### Changed + +- Change default listen address from default_ipv4 to 127.0.0.1 + +## [1.0.1] + +- First version uploaded to Ansible Galaxy + ## [1.0.0] ### Changed -- Initial release \ No newline at end of file +- Initial release diff --git a/roles/atuin_client/README.md b/roles/atuin_client/README.md index 67f0bb7..5abfa01 100644 --- a/roles/atuin_client/README.md +++ b/roles/atuin_client/README.md @@ -27,6 +27,9 @@ Mind that the musl build (at the time of writing) is only available for x86_64 L The only resort in that case is to use cargo to install atuin. I might implement that in a future version of this role. +Please see the `defaults/main.yml` file for the other configurable variables, their +default values and an explanation of what they are for. + Dependencies ------------ @@ -61,4 +64,4 @@ Author Information This role was created by Maxim Burgerhout as part fo the wzzrd.atuin Ansible collection. -Please log issues at https://github.com/wzzrd/ansible-collection-atuin. \ No newline at end of file +Please log issues at https://github.com/wzzrd/ansible-collection-atuin. diff --git a/roles/atuin_server/README.md b/roles/atuin_server/README.md index 80f3f59..9338bed 100644 --- a/roles/atuin_server/README.md +++ b/roles/atuin_server/README.md @@ -22,7 +22,7 @@ Role Variables | atuin_server_user | atuin | The name of the user owning the atuin server process | false | | atuin_server_group | atuin | The name of the group owning the atuin server process | false | | atuin_server_home | /home/atuin | The home directory for the atuin server user | false | -| atuin_server_host | "{{ ansible_default_ipv4.address }}" | IP address the atuin server process will listen on | false | +| atuin_server_host | 127.0.0.1 | IP address the atuin server process will listen on | false | | atuin_server_port | 8888 | The port the atuin server process will listen on | false | | atuin_server_open_registration | false | Whether or not the server will freely allow registration | false | | atuin_server_max_history_length | 8192 | Maximum length of one history entry | false | @@ -71,4 +71,4 @@ Author Information This role was created by Maxim Burgerhout as part fo the wzzrd.atuin Ansible collection. -Please log issues at https://github.com/wzzrd/ansible-collection-atuin. \ No newline at end of file +Please log issues at https://github.com/wzzrd/ansible-collection-atuin.