Permalink
Switch branches/tags
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
118 lines (74 sloc) 2.99 KB

jak

.. toctree::
   :maxdepth: 2
   :caption: Contents:

jak is a tool for encrypting files. jak works extra well if used in a git repository.

Warning

jaks encryption works. But use is under your own responsibility. I would highly recommend you take the auto-commit hook on a dry run before actually relying on it.

Install

pip install jak

Quickstart

cd ~/folderThatMayOrMayNotBeARepo
jak start

edit jakfile # add which files you want to have be encrypted.

jak encrypt all

# All files listen in the jakfile should now be encrypted.

We also made this video that might be helpful for running through a basic setup in a git repository.

Stewardship

Dispel is the main steward of jaks development. But all contributions are encouraged and welcome. Please read the :ref:`contribution guide <contributor>` for more information on contributing.

Table of contents

.. toctree::
   :maxdepth: 1

   guide/usage
   guide/advanced
   guide/commands
   guide/contributor
   security
   supported-platforms
   changelog


Supported platforms

jak works if you have a modern Python (2.7-3.6) installed on a *nix system.

:ref:`You can read about it in excrutiating detail here. <support_detailed>`

Proposed future features and enhancements

  • Make maintaining encrypted state of files optional
  • Avoid polluting filesystems with .jak folders?
  • Windows support
  • Easier key rotation

License

Copyright 2016-2017 Dispel, LLC and contributors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.