{"id":17526311,"url":"https://github.com/tycho-kirchner/shournal","last_synced_at":"2025-03-06T06:30:29.759Z","repository":{"id":37600775,"uuid":"198096673","full_name":"tycho-kirchner/shournal","owner":"tycho-kirchner","description":"Log shell-commands and used files. Snapshot executed scripts. Fully automatic.","archived":false,"fork":false,"pushed_at":"2024-08-28T09:29:38.000Z","size":2827,"stargazers_count":167,"open_issues_count":4,"forks_count":9,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-08-28T10:50:45.618Z","etag":null,"topics":["bash","command-tracker","computational-science","file-tracker","lowlevel","provenance","reproducibility","reproducible-research","reproducible-science","shell","zsh"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tycho-kirchner.png","metadata":{"files":{"readme":"README-compile.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-21T19:26:47.000Z","updated_at":"2024-08-28T09:29:41.000Z","dependencies_parsed_at":"2024-03-02T02:21:39.419Z","dependency_job_id":"50e93d24-1778-40e4-b3d2-5f8aedf09f45","html_url":"https://github.com/tycho-kirchner/shournal","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tycho-kirchner%2Fshournal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tycho-kirchner%2Fshournal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tycho-kirchner%2Fshournal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tycho-kirchner%2Fshournal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tycho-kirchner","download_url":"https://codeload.github.com/tycho-kirchner/shournal/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242161151,"owners_count":20081814,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","command-tracker","computational-science","file-tracker","lowlevel","provenance","reproducibility","reproducible-research","reproducible-science","shell","zsh"],"created_at":"2024-10-20T15:01:36.937Z","updated_at":"2025-03-06T06:30:29.320Z","avatar_url":"https://github.com/tycho-kirchner.png","language":"C++","funding_links":[],"categories":["\u003ca name=\"cpp\"\u003e\u003c/a\u003eC++","C++","\u003ca name=\"system\"\u003e\u003c/a\u003eSystem tools"],"sub_categories":[],"readme":"\n# Compile and install from source\n\n* Install gcc \u003e= 5.0. Other compilers might work but are untested.\n* Install cmake \u003e= 3.6 and make\n* For safe generation of uuids it is recommend to install uuidd (uuid-runtime)\n* Install qt-dev, uuid-dev, qt-sqlite-driver, Qt version \u003e= 5.6.\n  *With a little effort, shournal could be modified to\n  support Qt version \u003e= 5.3. Please open an issue, if that would\n  be helpful to you.*\n* To build the kernel-module the headers are also required\n  (linux-headers-$(uname -r))\n\n  *Packages lists*:\n\n  Debian:\n  ~~~\n  apt-get install g++ cmake make qtbase5-dev libqt5sql5-sqlite \\\n   uuid-dev libcap-dev uuid-runtime linux-headers-$(dpkg --print-architecture) dkms\n  ~~~\n  Ubuntu:\n  ~~~\n  apt-get install g++ cmake make qtbase5-dev libqt5sql5-sqlite \\\n   uuid-dev libcap-dev uuid-runtime dkms \\\n   linux-headers-generic # or linux-headers-generic-hwe-$(lsb_release -rs) on HWE\n  ~~~\n  Opensuse:\n  ~~~\n  zypper install gcc-c++ cmake make libqt5-qtbase-devel \\\n   libQt5Sql5-sqlite libuuid-devel libcap-devel uuidd \\\n   kernel-default-devel dkms\n  ~~~\n  Arch Linux:\n  ~~~\n  yay -S gcc cmake make qt5-base uuid libcap linux-headers dkms\n  ~~~\n\n  CentOS (note: CentOS 7 as of July 2019 only ships with gcc 4.8\n  -\u003e compile gcc \u003e= 5.0 yourself. cmake3 and cmake are seperate packages\n  where cmake in version 2 is the default. Please ensure to compile with\n  cmake3. The kernel 3.10 is too old for *shournal*'s kernel-module.\n  Either install a newer one or stick with the fanotify-edition):\n  ~~~\n  yum install gcc-c++ cmake3 make qt5-qtbase-devel libuuid-devel \\\n  libcap-devel uuidd kernel-devel dkms\n  ~~~\n\n* In the source-tree-directory, enter the following commands to\n  compile and install. By default `SHOURNAL_EDITION` `full` is built (see below).\n  Supported options include `full, docker, ko, fanotify`.\n  The `ko` (kernel module) edition does not install the fanotify backend\n  which may be desirable for security reasons as the setuid-binary\n  `shournal-run-fanotify` is omitted. For a description of the other editions\n  refer to [Binary releases](./README.md#binary-releases).\n  ~~~\n  mkdir -p build\n  cd build\n  # If you later want to generate a deb-package, it is recommended\n  # to use /usr as prefix: -DCMAKE_INSTALL_PREFIX=/usr\n  cmake -DSHOURNAL_EDITION=full ..\n  make\n  # as root:\n  make install\n  # or if using a Debian-based distribution, generate a .deb-package:\n  cpack -G DEB\n  ~~~\n\n\n**After compile and install**: \u003cbr\u003e\nIf you created a .deb-package, please see\n[Binary releases](./README.md#binary-releases). **Otherwise:**\n\n**Kernel-module backend** \u003cbr\u003e\nFor a quick test, the module can be loaded right from the build-tree:\n`$ insmod kernel/shournalk.ko`. \u003cbr\u003e\nTo install the kernel-module (not built in SHOURNAL_EDITION's\n*docker* and *fanotify*) it is recommended to install it using dkms, e.g.:\n~~~\ndkms build shournalk/2.4    # adjust version as needed.\ndkms install shournalk/2.4\n# and load it with\nmodprobe shournalk\n~~~\nDepending on your distribution the dkms service may be disabled, thus\nafter a kernel-update shournal stops working. At least on\nOpensuse Tumbleweed it can be enabled with\n~~~\nsystemctl enable dkms\n~~~\n\n**fanotify backend** \u003cbr\u003e\nAdd a group to your system, which is primarily needed for\nthe shell-integration:\n\n  ```groupadd shournalmsenter```\n\nHowever, *do not add any users to that group*. It is part of a permission\ncheck, where root adopts that gid (within shournal).\nIf you don't like the default group name, you can specify your own: at\nbuild time pass the following to cmake:\n\n  ```-DMSENTER_GROUPNAME=$your_group_name```\n\nFor **further post-install steps** please see\n[Binary releases](./README.md#binary-releases). Please note\nthat file-paths may need to be adjusted, e.g. the location of\nthe `SOURCE_ME.$shell_name` scripts after `make install` is typically\n`/usr/local/share/shournal/`, not `/usr/share/shournal/`.\n\n\nTo **uninstall**, after having installed with `make install`, you can\nexecute \u003cbr\u003e\n`xargs rm \u003c install_manifest.txt`, but see\n[here](https://stackoverflow.com/a/44649542/7015849) for the\nlimitations. \u003cbr\u003e\nTo uninstall the kernel-module backend: \u003cbr\u003e\n`sudo dkms remove shournalk/2.4` (adjust version as needed).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftycho-kirchner%2Fshournal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftycho-kirchner%2Fshournal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftycho-kirchner%2Fshournal/lists"}