{"id":14128472,"url":"https://github.com/xtaran/unburden-home-dir","last_synced_at":"2025-10-04T21:45:12.976Z","repository":{"id":1151008,"uuid":"1034815","full_name":"xtaran/unburden-home-dir","owner":"xtaran","description":"Automatically unburden $HOME from caches, etc. Useful for $HOME on SSDs, small disks or slow NFS homes. Can be triggered via an hook in /etc/X11/Xsession.d/.","archived":false,"fork":false,"pushed_at":"2024-06-15T01:35:44.000Z","size":902,"stargazers_count":51,"open_issues_count":6,"forks_count":12,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-12-05T08:44:52.195Z","etag":null,"topics":["backup","cleanup","disk-space","homedir","nfs","perl","ssd","symlinks","tmpfs"],"latest_commit_sha":null,"homepage":"https://unburden-home-dir.readthedocs.io/","language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xtaran.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2010-10-29T13:00:53.000Z","updated_at":"2024-10-22T19:09:57.000Z","dependencies_parsed_at":"2022-08-16T12:15:27.648Z","dependency_job_id":null,"html_url":"https://github.com/xtaran/unburden-home-dir","commit_stats":null,"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xtaran%2Funburden-home-dir","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xtaran%2Funburden-home-dir/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xtaran%2Funburden-home-dir/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xtaran%2Funburden-home-dir/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xtaran","download_url":"https://codeload.github.com/xtaran/unburden-home-dir/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228571844,"owners_count":17938772,"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":["backup","cleanup","disk-space","homedir","nfs","perl","ssd","symlinks","tmpfs"],"created_at":"2024-08-15T16:01:45.181Z","updated_at":"2025-10-04T21:45:07.944Z","avatar_url":"https://github.com/xtaran.png","language":"Perl","funding_links":[],"categories":["Perl"],"sub_categories":[],"readme":"Unburden Your Home Directory\n============================\n\n[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/xtaran/unburden-home-dir/CI?style=plastic)](https://github.com/xtaran/unburden-home-dir/actions/workflows/actions.yml)\n[![Documentation Status](https://readthedocs.org/projects/unburden-home-dir/badge/?version=latest)](https://readthedocs.org/projects/unburden-home-dir/?badge=latest)\n[![Coverage by Coveralls](https://img.shields.io/coveralls/xtaran/unburden-home-dir.svg)](https://coveralls.io/r/xtaran/unburden-home-dir)\n[![Coverage by Codecov](https://codecov.io/gh/xtaran/unburden-home-dir/branch/master/graph/badge.svg)](https://codecov.io/gh/xtaran/unburden-home-dir)\n[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1116/badge)](https://bestpractices.coreinfrastructure.org/projects/1116)\n\n[![Packaging status unburden-home-dir](https://repology.org/badge/vertical-allrepos/unburden-home-dir.svg)](https://repology.org/metapackage/unburden-home-dir)\n\n`unburden-home-dir` allows users to move cache files from browsers,\netc. off their home directory, i.e. on a local harddisk or tmpfs and\nreplace them with a symbolic link to the new location (e.g. on `/tmp/`\nor `/scratch/`) upon login. Optionally the contents of the directories\nand files can be removed instead of moved.\n\nThis is helpful at least in the following cases:\n\n* The idea-giving case are big workstation setups where `$HOME` is on\n  NFS and all those caches put an unnecessary burden (hence the name)\n  on the file server since caching over NFS doesn't have the best\n  performance and may clog the NFS server, too.\n\n* A similar case, but with different purpose is reducing I/O on mobile\n  devices like laptops or netbooks to extend the battery life or\n  reduce the wearing down of CF or SD cards, e.g. in single board\n  computers like the [Raspberry Pi](https://www.raspberrypi.org/) or\n  [ALIX](http://www.pcengines.ch/alix.htm) or\n  [APU](http://www.pcengines.ch/apu.htm) boards: Moving browser caches\n  etc. off the real disk into a tmpfs filesystem reduces the amount of\n  disk I/O which reduces the power consumption of the disk.\n\n* Another type of use cases for unburden-home-dir is to reduce disk\n  space usage, e.g. on devices with small disk space but a lot of RAM\n  as seen often on boxes with flash disks or early netbooks, e.g. the\n  first EeePC with 4GB disk space and 2GB RAM are not seldom. In this\n  case you want to move off as many cache files, etc. as possible to\n  some tmpfs filesystem, e.g. `/tmp/`.\n\n* It may also help to reduce the amount of needed backup disk space by\n  keeping those files in places where they don't get backed up. In\n  that case it's an alternative to keeping the blacklist in your\n  backup software up-to-date.\n\n* Another pragmatic use case may be to stay — as a user — within a\n  given disk quota. :-)\n\nThis project initially started as an `Xsession` hook. It now consists\nof a perl script which optionally can also be called from a provided\n`Xsession` hook.\n\nThe full documentation can be read online\n[at ReadTheDocs](https://unburden-home-dir.readthedocs.io/),\n[at Gitbook](https://xtaran.gitbooks.io/unburden-home-dir/) or\ndownloaded\n[as e-book at Gitbook](https://www.gitbook.com/book/xtaran/unburden-home-dir/details).\n\n\nAuthor\n------\n\n[Axel Beckert](https://axel.beckert.ch/) \u003cabe@deuxchevaux.org\u003e\n\nunburden-home-dir initially has been developed for usage at\n[Dept. of Physics](https://www.phys.ethz.ch/),\n[ETH Zurich](https://www.ethz.ch/).\n\n\nLicense\n-------\n\n`unburden-home-dir` is free software: you can redistribute it and/or\nmodify it under the terms of the GNU General Public License as\npublished by the Free Software Foundation, either version 2 of the\nLicense, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful, but\nWITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\nGeneral Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program in the file COPYING.  If not, see\n[GNU's license web page](https://www.gnu.org/licenses/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxtaran%2Funburden-home-dir","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxtaran%2Funburden-home-dir","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxtaran%2Funburden-home-dir/lists"}