Tomb/README.md

59 lines
2.4 KiB
Markdown
Raw Normal View History

2023-09-20 14:52:12 +00:00
# Tomb: The Linux Crypto Undertaker
2015-12-22 17:22:48 +00:00
2022-11-14 10:53:54 +00:00
[![Build Status](https://github.com/dyne/tomb/actions/workflows/linux.yml/badge.svg)](https://github.com/dyne/Tomb/actions)
<!-- [![Build Status](https://github.com/dyne/tomb/actions/workflows/portable.yml/badge.svg)](https://github.com/dyne/Tomb/actions) -->
2023-09-20 14:52:12 +00:00
Minimalistic command line tool based on Linux dm-crypt and LUKS, trusted by hackers since 2007.
2023-09-20 14:52:12 +00:00
You can keep your volumes secure and easily manageable with simple commands.
2023-09-20 14:52:12 +00:00
![tomb's logo](https://github.com/dyne/Tomb/blob/master/extras/images/monmort.png)
2014-04-15 10:56:00 +00:00
```
$ tomb dig -s 100 secret.tomb
$ tomb forge secret.tomb.key
$ tomb lock secret.tomb -k secret.tomb.key
```
To open it, do
```
$ tomb open secret.tomb -k secret.tomb.key
```
2023-09-20 14:52:12 +00:00
And after you are done
```
$ tomb close
```
2023-09-20 14:52:12 +00:00
Or, if you are in a hurry, kill all processes with open files inside your tomb and close it.
```
2023-09-20 14:52:12 +00:00
$ tomb slam
```
2023-09-20 14:52:12 +00:00
## [Get started on dyne.org/software/tomb](https://dyne.org/software/tomb)
2023-09-20 14:52:12 +00:00
<a href="https://dyne.org/software/tomb"><img src="https://files.dyne.org/software_by_dyne.png" width="30%"></a>
2023-09-20 14:52:12 +00:00
All information is found on our website.
2013-05-25 14:29:19 +00:00
2023-09-20 14:52:12 +00:00
Use only stable and signed releases in production!
2013-05-25 14:29:19 +00:00
2024-01-23 23:42:50 +00:00
### 💾 [Download from files.dyne.org/tomb](https://files.dyne.org/tomb/)
2010-08-23 13:10:57 +00:00
2023-09-20 14:52:12 +00:00
Tomb's development is community-based!
2023-09-20 14:52:12 +00:00
## How can you help
2010-08-23 13:10:57 +00:00
2023-09-20 14:52:12 +00:00
Donations are very welcome on [dyne.org/donate](https://www.dyne.org/donate)
2010-08-23 13:10:57 +00:00
2023-09-20 14:52:12 +00:00
Translations are also welcome: see our simple [translation guide](https://github.com/dyne/Tomb/blob/master/extras/translations/README.md)
2010-08-23 13:10:57 +00:00
2023-09-20 14:52:12 +00:00
Tomb's code is short and readable: don't be afraid to inspect it! If you plan to submit a PR, please remember that this is a minimalist tool, and the code should be short and readable. Also, first, read our small intro to [Tomb's coding style](doc/HACKING.txt).
2017-03-18 14:24:01 +00:00
2023-09-20 14:52:12 +00:00
We have a [space for issues](https://github.com/dyne/Tomb/issues) open for detailed bug reports. Always include the Tomb version being used when filing a case, please.
2017-03-18 14:24:01 +00:00
2023-09-20 14:52:12 +00:00
There is also a [space for discussion](https://github.com/dyne/Tomb/discussions) of new features, desiderata and whatnot on github.
# Licensing
2024-01-23 23:44:00 +00:00
Tomb is Copyright (C) 2007-2024 by the Dyne.org Foundation and maintained by [Jaromil](https://github.com/jaromil). The [AUTHORS](AUTHORS.md) file contains more information on all the developers involved. The license is GNU Public License v3.
2023-09-20 14:52:12 +00:00
## [More info on dyne.org/software/tomb](https://dyne.org/software/tomb)