Commit 55bbba4f authored by Maarten de Waard's avatar Maarten de Waard 🤘🏻
Browse files

Merge branch '1-setup-documentation-in-sphinx' into 'master'

start documentation in sphinx

Closes #1

See merge request !1
parents f38021d3 971169bf
......@@ -2,3 +2,4 @@
*.swp
*.o
cryptops-api
docs/_build
# Usage
`cryptops-api --root-device=DEV --crypt-name=LABEL [--notify-command=COMMAND]`
```sh
cryptops-api --root-device=DEV --crypt-name=LABEL [--notify-command=COMMAND]
```
* The `--root-device=DEV` option is mandatory. `DEV` should be the root device
of the machine, like `/dev/sda` or `/dev/xvda`.
......
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = python3 -msphinx
SPHINXPROJ = Cryptops
SOURCEDIR = .
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
API Documentation
=================
Coming soon!
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Cryptops documentation build configuration file, created by
# sphinx-quickstart on Tue Oct 17 10:00:20 2017.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
from recommonmark.parser import CommonMarkParser
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# Support writing in Markdown
source_parsers = {
'.md': CommonMarkParser,
}
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = ['.rst', '.md']
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = 'Cryptops'
copyright = '2017, <a href="https://greenhost.net"/>Greenhost</a>'
author = 'Greenhost'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.1'
# The full version, including alpha/beta/rc tags.
release = '0.1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'en'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# This is required for the alabaster theme
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
html_sidebars = {
'**': [
'about.html',
'navigation.html',
'relations.html', # needs 'show_related': True theme option to display
'searchbox.html',
'donate.html',
]
}
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'Cryptopsdoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'Cryptops.tex', 'Cryptops Documentation',
'Greenhost', 'manual'),
]
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'cryptops', 'Cryptops Documentation',
[author], 1)
]
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'Cryptops', 'Cryptops Documentation',
author, 'Cryptops', 'One line description of project.',
'Miscellaneous'),
]
.. Cryptops documentation master file, created by
sphinx-quickstart on Tue Oct 17 10:00:20 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
CryptOps: Moving to a world with encrypted VPSs only
====================================================
Full disk encryption on Virtual Private Servers
-----------------------------------------------
These days, data storage using the "cloud" or virtual private servers (VPSs) on
the Internet is extremely flexible and easy to setup. Anyone can boot a new VPS
within seconds and start storing information on it. However, the "cloud" is just
someone else's hard drive, which comes with certain security risks.
Infrastructure providers can access "your" data stored on the cloud with extreme
ease. But as managing your own infrastructure can be a nightmare for some, it
comes with no surprise that virtual private servers have gained immense
popularity over the last several years.
Is it possible to use virtual systems and still make sure that all your data is
stored encrypted, so only the user has access to the data and not the service
provider? Existing solutions often rely on encryption keys being managed by the
service providers themselves or the data being encrypted at the application
level.
CryptOps is a new, provider agnostic approach which makes full-disk encryption
at the Virtual Machine layer more accessible and secure for the average user.
Users can encrypt their VPSs by logging into a `Dropbear SSH`_ shell
that runs in the initrd. In this environment, the user is allowed to type
commands into the "CryptOps Client", which communicates with the local "CryptOps
API" to encrypt and unlock disks. This open source tool currently supports
encrypting and decrypting new and already existing VPSs. It also allows the user
to manage their SSH and LUKS encryption keys. The CryptOps framework has been
designed to be open & extensible, allowing it to support external client
applications in the future.
Find the code at `<https://code.greenhost.net/open/cryptops>`_ and an example initrd at
`<https://code.greenhost.net/open/cryptops-initrd>`_
.. _`Dropbear SSH`: https://matt.ucc.asn.au/dropbear/dropbear.html
.. _Greenhost: https://greenhost.net
.. toctree::
:maxdepth: 2
:caption: Contents:
readme.md
api_documentation.rst
.. Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
../README.md
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment