Llewellyn/Tomb
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/Tomb.git synced 2024-11-14 16:54:03 +00:00
Code Issues Packages Projects Releases Wiki Activity
afe0390d93
Tomb/extras/portable/README.md

70 lines
2.7 KiB
Markdown
Raw Normal View History

first basic implementation of portable tomb this new "flavor" of tomb uses veracrypt for mounted volumes and POSIX sh only for its scripting, is a work in progress and still lacks full functionality, but provides a proof-of-concept to be developed further if needs arise.
2022-11-13 21:00:41 +00:00
# Portable Tomb :: the crypto undertaker runs everywhere
documentation update for release long due, was ready in november 2022 and basically left unchanged at that stage, except the deprecation of veracrypt in the experimental portable branch, which is not included in the stable release.
2023-09-18 14:04:19 +00:00
[![continuous integration tests badge](https://github.com/dyne/tomb/actions/workflows/portable.yml/badge.svg)](https://github.com/dyne/Tomb/actions) test coverage status for portability
updated portable readme with links to milestones and more info
2022-11-14 09:39:38 +00:00
first basic implementation of portable tomb this new "flavor" of tomb uses veracrypt for mounted volumes and POSIX sh only for its scripting, is a work in progress and still lacks full functionality, but provides a proof-of-concept to be developed further if needs arise.
2022-11-13 21:00:41 +00:00
## ⚠️ WORK IN PROGRESS 🛠️
documentation update for release long due, was ready in november 2022 and basically left unchanged at that stage, except the deprecation of veracrypt in the experimental portable branch, which is not included in the stable release.
2023-09-18 14:04:19 +00:00
This is the portable version of [Tomb](https://github.com/dyne/tomb)
first basic implementation of portable tomb this new "flavor" of tomb uses veracrypt for mounted volumes and POSIX sh only for its scripting, is a work in progress and still lacks full functionality, but provides a proof-of-concept to be developed further if needs arise.
2022-11-13 21:00:41 +00:00
[![software by Dyne.org](https://files.dyne.org/software_by_dyne.png)](http://www.dyne.org)
# Purpose
Portable tomb achieves direct **interoperable access to tomb volumes** between:
documentation update for release long due, was ready in november 2022 and basically left unchanged at that stage, except the deprecation of veracrypt in the experimental portable branch, which is not included in the stable release.
2023-09-18 14:04:19 +00:00
- GNU base Linux (Ubuntu)
- Busybox based Linux (Alpine)
- MS/Windows using WSL2 (Ubuntu)
- FreeBSD (WIP using libluksde)
- ~~Apple/OSX using [MacFUSE](https://osxfuse.github.io/)~~
first basic implementation of portable tomb this new "flavor" of tomb uses veracrypt for mounted volumes and POSIX sh only for its scripting, is a work in progress and still lacks full functionality, but provides a proof-of-concept to be developed further if needs arise.
2022-11-13 21:00:41 +00:00
documentation update for release long due, was ready in november 2022 and basically left unchanged at that stage, except the deprecation of veracrypt in the experimental portable branch, which is not included in the stable release.
2023-09-18 14:04:19 +00:00
After some extensive testing during 2022, __adoption of Veracrypt in portable Tomb has been dropped__ because of unreliability and bad performance.
Portable tomb stays as an experimental branch that aims to reduce dependencies and in particular uses only the **POSIX sh interpreter**.
first basic implementation of portable tomb this new "flavor" of tomb uses veracrypt for mounted volumes and POSIX sh only for its scripting, is a work in progress and still lacks full functionality, but provides a proof-of-concept to be developed further if needs arise.
2022-11-13 21:00:41 +00:00
updated portable readme with links to milestones and more info
2022-11-14 09:39:38 +00:00
# Status
Portable tomb development is in progress and tracked via issues and the [portable milestone](https://github.com/dyne/Tomb/milestone/9).
first basic implementation of portable tomb this new "flavor" of tomb uses veracrypt for mounted volumes and POSIX sh only for its scripting, is a work in progress and still lacks full functionality, but provides a proof-of-concept to be developed further if needs arise.
2022-11-13 21:00:41 +00:00
## Features
updated portable readme with links to milestones and more info
2022-11-14 09:39:38 +00:00
The following features will be implemented where possible:
first basic implementation of portable tomb this new "flavor" of tomb uses veracrypt for mounted volumes and POSIX sh only for its scripting, is a work in progress and still lacks full functionality, but provides a proof-of-concept to be developed further if needs arise.
2022-11-13 21:00:41 +00:00
updated portable readme with links to milestones and more info
2022-11-14 09:39:38 +00:00
- mount bind (Linux only)
- ps / slam
- resize (pending investigation)
- index & search ([recoll based](https://github.com/dyne/Tomb/issues/211))
- bury / exhume
first basic implementation of portable tomb this new "flavor" of tomb uses veracrypt for mounted volumes and POSIX sh only for its scripting, is a work in progress and still lacks full functionality, but provides a proof-of-concept to be developed further if needs arise.
2022-11-13 21:00:41 +00:00
## Dependencies
documentation update for release long due, was ready in november 2022 and basically left unchanged at that stage, except the deprecation of veracrypt in the experimental portable branch, which is not included in the stable release.
2023-09-18 14:04:19 +00:00
- FreeBSD: `fusefs-libs3 fusefs-lkl e2fsprogs util-linux libluksde`
first basic implementation of portable tomb this new "flavor" of tomb uses veracrypt for mounted volumes and POSIX sh only for its scripting, is a work in progress and still lacks full functionality, but provides a proof-of-concept to be developed further if needs arise.
2022-11-13 21:00:41 +00:00
- Linux: `fuse3 util-linux`
- crossplatform [Veracrypt binaries](https://files.dyne.org/tomb3/third-party) console-only
updated portable readme with links to milestones and more info
2022-11-14 09:39:38 +00:00
## Note on Veracrypt
The way upstream developers distribute Veracrypt is far from meeting our minimalist needs, but the console-only binary once installed has a few library dependencies and is all what we need.
first basic implementation of portable tomb this new "flavor" of tomb uses veracrypt for mounted volumes and POSIX sh only for its scripting, is a work in progress and still lacks full functionality, but provides a proof-of-concept to be developed further if needs arise.
2022-11-13 21:00:41 +00:00
updated portable readme with links to milestones and more info
2022-11-14 09:39:38 +00:00
I setup [my own build](https://github.com/jaromil/veracrypt) and provide binary builds of Veracrypt v1.25.9 for download on Tomb's file repository for testing purposes.
first basic implementation of portable tomb this new "flavor" of tomb uses veracrypt for mounted volumes and POSIX sh only for its scripting, is a work in progress and still lacks full functionality, but provides a proof-of-concept to be developed further if needs arise.
2022-11-13 21:00:41 +00:00
# Disclaimer
documentation update for release long due, was ready in november 2022 and basically left unchanged at that stage, except the deprecation of veracrypt in the experimental portable branch, which is not included in the stable release.
2023-09-18 14:04:19 +00:00
Tomb is Copyright (C) 2007-2023 by the Dyne.org Foundation and
first basic implementation of portable tomb this new "flavor" of tomb uses veracrypt for mounted volumes and POSIX sh only for its scripting, is a work in progress and still lacks full functionality, but provides a proof-of-concept to be developed further if needs arise.
2022-11-13 21:00:41 +00:00
developed by [Jaromil](https://github.com/jaromil).
This source code is free software; you can redistribute it and/or
modify it under the terms of the GNU Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This source code is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. Please refer
to the GNU Public License for more details.
You should have received a copy of the GNU Public License along with
this source code; if not, write to: Free Software Foundation, Inc.,
675 Mass Ave, Cambridge, MA 02139, USA.
Reference in New Issue Copy Permalink