aboutsummaryrefslogtreecommitdiff
path: root/Documentation
AgeCommit message (Collapse)Author
2018-08-11reverse mode: add --exclude optionJakob Unterwurzacher
https://github.com/rfjakob/gocryptfs/issues/235
2018-07-15file-format.md: list full block overheadrfjakob
For large files, the overhead will be 0.78125 %.
2018-07-07MANPAGE: add proper description textJakob Unterwurzacher
We only had an "options" section which was mislabeled as "description". Add a proper description text.
2018-07-01README: Add folders side-by-side animation gifJakob Unterwurzacher
10 second animation that shows what gocryptfs does.
2018-06-12Update README and MANPAGE for v1.5v1.5Jakob Unterwurzacher
Also update the performance numbers. I see some slowdown, reason is not yet clear, but nothing to block the release.
2018-04-03fsck: report skipped corrupt filesJakob Unterwurzacher
OpenDir and ListXAttr skip over corrupt entries, readFileID treats files the are too small as empty. This improves usability in the face of corruption, but hides the problem in a log message instead of putting it in the return code. Create a channel to report these corruptions to fsck so it can report them to the user. Also update the manpage and the changelog with the -fsck option. Closes https://github.com/rfjakob/gocryptfs/issues/191
2018-03-22Add `-masterkey=stdin` functionalityJakob Unterwurzacher
https://github.com/rfjakob/gocryptfs/issues/218
2018-02-03MANPAGE: improve markdown renderingJakob Unterwurzacher
The man page is rendered on github at https://github.com/rfjakob/gocryptfs/blob/master/Documentation/MANPAGE.md . Improve formatting a little.
2018-01-21Documentation: update xfstests outputv1.4.3Jakob Unterwurzacher
Also update the v1.4.3 release date to today. The release was delayed one day.
2018-01-21Documentation: add extractloop example outputJakob Unterwurzacher
2018-01-20MANPAGE: improve description of -o and -koJakob Unterwurzacher
Was unclear for new users - see https://github.com/rfjakob/gocryptfs/issues/194
2018-01-10Provide basic man page for xray tool (#193)Felix Lechner
Provide basic man page for xray tool
2018-01-10Fix spellingFelix Lechner
2017-12-05Documentation: Add reverse mode benchmark resultsJakob Unterwurzacher
2017-11-21main: Add '-devrandom' commandline optionSebastian Lackner
Allows to use /dev/random for generating the master key instead of the default Go implementation. When the kernel random generator has been properly initialized both are considered equally secure, however: * Versions of Go prior to 1.9 just fall back to /dev/urandom if the getrandom() syscall would be blocking (Go Bug #19274) * Kernel versions prior to 3.17 do not support getrandom(), and there is no check if the random generator has been properly initialized before reading from /dev/urandom This is especially useful for embedded hardware with low-entroy. Please note that generation of the master key might block indefinitely if the kernel cannot harvest enough entropy.
2017-11-12main: add "-sharedstorage" flagJakob Unterwurzacher
At the moment, it does two things: 1. Disable stat() caching so changes to the backing storage show up immediately. 2. Disable hard link tracking, as the inode numbers on the backing storage are not stable when files are deleted and re-created behind our back. This would otherwise produce strange "file does not exist" and other errors. Mitigates https://github.com/rfjakob/gocryptfs/issues/156
2017-10-19MANPAGE: explain that you may have to pass -aessiv with -masterkeyJakob Unterwurzacher
...if the filesystem was created with that option (or reverse mode). Mitigates https://github.com/rfjakob/gocryptfs/issues/148
2017-09-10performance.txt: specify READ testsJakob Unterwurzacher
2017-09-03performance.txt: update for v1.4.1 latest commits, and kernel updateJakob Unterwurzacher
$ uname -a Linux brikett 4.12.5-300.fc26.x86_64 #1 SMP Mon Aug 7 15:27:25 UTC 2017 x86_64 x86_64 x86_64 GNU/Linux
2017-08-21MANPAGE: update exit codesJakob Unterwurzacher
The exit codes have been documented in CLI_ABI.md for a while, but they should also be listed in the man page. Also fix the rendering of "[-o COMMA-SEPARATED-OPTIONS]", where the square brackets where interpreted as something. Escape all square brackets to be safe.
2017-08-15Update performance.txt for Linux kernel upgradeJakob Unterwurzacher
For some reason, writing became a lot faster in Linux 4.11 (scheduler improvements?).
2017-08-15Update performance.txt for to Getdents changeJakob Unterwurzacher
2017-08-15docs: label "ENV CHANGE" columnJakob Unterwurzacher
2017-07-01Update performance.txt with new resultsJakob Unterwurzacher
Massive speed boost for streaming reads.
2017-06-29Update performance.txt with new numbersJakob Unterwurzacher
2017-06-29Update performance.txt with new numbersJakob Unterwurzacher
2017-06-20Update performance numbersJakob Unterwurzacher
2017-06-20MANPAGE: reorder options to match "-hh" output; add "-hkdf", "-trace"Jakob Unterwurzacher
2017-06-11Add performance numbers for v1.3-69-ge52594dJakob Unterwurzacher
2017-06-11Add performance numbers for last changeJakob Unterwurzacher
Slight streaming write improvement.
2017-06-09performance.txt: add numbers for latest changeJakob Unterwurzacher
Also, get rid of the half-empty line.
2017-06-01Don't cap GOMAXPROCS at 4.Jakob Unterwurzacher
Before Go 1.5, GOMAXPROCS defaulted to 1, hence it made sense to unconditionally increase it to 4. But since Go 1.5, GOMAXPROCS defaults to the number of cores, so don't keep it from increasing above 4. Also, update the performance numbers.
2017-06-01Implement force_owner option to display ownership as a specific user.Charles Duffy
2017-05-30main: add "-info" optionJakob Unterwurzacher
Pretty-prints the config while stripping out sensitive (and uninteresting) data https://github.com/rfjakob/gocryptfs/issues/111
2017-05-25doc: add performance numbers for 1.3-27Jakob Unterwurzacher
2017-05-14doc: CLI_ABI.md: fix exitcodes.go linkJakob Unterwurzacher
Needs a leading "..".
2017-05-14doc: update CLI_ABI.md with new exit codesJakob Unterwurzacher
All exit codes that are likely to occour are listed.
2017-04-24forcedecode: tighten checksJakob Unterwurzacher
...and fix a few golint issues and print a scary warning message on mount. Also, force the fs to ro,noexec.
2017-04-23Add -forcedecodedanim7
Force decode of encrypted files even if the integrity check fails, instead of failing with an IO error. Warning messages are still printed to syslog if corrupted files are encountered. It can be useful to recover files from disks with bad sectors or other corrupted media. Closes https://github.com/rfjakob/gocryptfs/pull/102 .
2017-03-28MANPAGE: reformat to GFM (github flavored markdown)Jakob Unterwurzacher
This makes it render properly on the github webinterface.
2017-03-25MANPAGE: fix alphabetical order and expand scryptn explainationJakob Unterwurzacher
2017-03-25Further explain the use of 'scryptn' parameter (#94)danim7
* Further explain the use of 'scryptn' parameter * Further explain the use of 'scryptn' parameter in MANPAGE * Use 28 as reasonable upper limit
2017-03-25README: use pre-rendered PNG logoJakob Unterwurzacher
This keeps the README working even if nuetzlich.net is unavailable. We use a PNG because github disallows embedding local SVGs.
2017-03-19MANPAGE: document "-serialize_reads"Jakob Unterwurzacher
2017-03-18benchmark: add md5sum read performance benchmarkJakob Unterwurzacher
2017-03-01CLI_ABI: smaller markdown subheadingsrfjakob
The old ones were rendered by github almost as big as the parent headings.
2017-02-26MANPAGE: document "-speed"Jakob Unterwurzacher
2017-02-26MANPAGE: document error code 12Jakob Unterwurzacher
2017-02-12Add CLI ABI documentationJakob Unterwurzacher
Closes https://github.com/rfjakob/gocryptfs/issues/77
2017-02-12Document "--" to stop option parsing in help text + man pageJakob Unterwurzacher
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-18 05:30:11 +0000