docs.html

{% extends 'base.html' %}
{% block content %}
    <div class="panel panel-default">
        <div class="panel-heading">
            <h3 id="whats-sublimall" class="panel-title">What's Sublimall ?</h3>
        </div>
        <div class="panel-body">
            <p>Sublimall is a server and a SublimeText plugin.</p>
            <p>The plugin create a compressed (and encrypted if you choose it) archive of your
            SublimeText configuration and send it to the server.</p>
            <p>You can store for now one package at the same time.</p>
            <p>After a long time you reinstall your system or you have a home and work computer so you
            can just type <kbd>Ctrl-Shift-P</kbd> and hit <kbd>Sublimall retrieve</kbd> to sync your
            other computer with your previously save configuration.</p>
        </div>
    </div>
    <div class="panel panel-default">
        <div class="panel-heading">
            <h3 id="how-to-install-plugin" class="panel-title">How to install SublimeText plugin ?</h3>
        </div>
        <div class="panel-body">
            <p>You'll need to have <strong>7zip</strong> installed on your system.</p>
            <ul>
                <li><strong>Ubuntu</strong>: <kbd>apt-get install p7zip-full</kbd></li>
                <li><strong>Osx</strong>: <kbd>brew install p7zip</kbd></li>
                <li><strong>Windows</strong>: Go to <a href="http://www.7-zip.org/download.html">7zip website</a></li>
            </ul>
            <p>In order to install Sublimall plugin you have two options, easiest method is if you already have <a href="https://sublime.wbond.net/"><strong>Package Control</strong></a> which I heavily recommand you to use.</p>
            <p>Hit <kbd>Ctrl-Shift-P</kbd> <kbd>Install Package</kbd> and type <kbd>Sublimall</kbd> to install it.</p>
        </div>
    </div>
    <div class="panel panel-default">
        <div class="panel-heading">
            <h3 id="how-can-trust" class="panel-title">How can I trust you ?</h3>
        </div>
        <div class="panel-body">
            <p>I'm <a href="http://toxi.nu">Geoffrey L.</a> from France. A Python and Django developer.</p>
            <p>If you want to use Sublimall you'll need a free account. No personal informations, no credit cards are required. I heavily encourage you to use encrypted method which means that I'll never read your synced packages. Counterpart is that if you forget your passphrase, you won't recover your configuration.</p>
            <p>Sublimall is opensource, <a href="https://github.com/toxinu/sublimall">client</a> and server (soon) sources are released under MIT Licenses. You can contribute, read the code, whatever you want.</p>
            <p>So you can host your own Sublimall server.</p>
        </div>
    </div>
    <div class="panel panel-default">
        <div class="panel-heading">
            <h3 id="can-you-read" class="panel-title">Can you read my packages content ?</h3>
        </div>
        <div class="panel-body">
            <p>If you use <em>encrypted</em> method, no.</p>
            <p>For now, in Sublimall encryption is optionnal but activated by default. I'm thinking about setting encryption mandatory and remove the choice.</p>
        </div>
    </div>
    <div class="panel panel-default">
        <div class="panel-heading">
            <h3 id="plugin-settings" class="panel-title">How to configure Sublimall plugin ?</h3>
        </div>
        <div class="panel-body">
            <p>Sublimall plugin configuration is very simple.</p>
            <p><strong>Warning!</strong> Sublimall is for now only compatible with SublimeText 3!</p>
            <p>You just have to click on <kbd>Preferences</kbd>, <kbd>Package Settings</kbd>, <kbd>Sublimall</kbd> and <kbd>Settings - User</kbd>.</p>
            <p>This is default configuration:</p>
            <pre>{
    ////////////////////////////
    //// Sublimall settings ////
    ////////////////////////////
    "api_root_url": "http://sublimall.org",
    "api_upload_url": "/api/upload/",
    "api_retrieve_url": "/api/retrieve/",

    ///////////////////////
    //// User settings ////
    ///////////////////////
    "email": "",
    "api_key": "",
    // Paths must be: "Packages/SublimeCodeIntel" or "Installed Packages/Sublimall"
    "ignore_packages": [],
    // Set true if you want to exclude packages managed by Package Control
    "exclude_from_package_control": false,
    // Set false if you don't want to encrypt your configuration
    "encrypt": true,
    // Upload timeout in seconds
    "http_upload_timeout": 120,
    // Download timeout in seconds
    "http_download_timeout": 120,
    // Path to 7zip executable, though Sublimall tries to find it out itself
    "7za_path": "",
    // HTTP proxy to use for HTTP requests. Support for authentication
    // Examples: http://user:password@host:port or http://ip:port
    "http_proxy": ""
}</pre>
            <p>Add you <em>email</em> and your <em>API key</em> which you can find on your <a href="{% url 'account' %}">account</a> page.</p>
            <p>If <kbd>encrypt</kbd> option is <kbd>true</kbd>, you'll prompt to a passphrase when you'll upload your configuration on Sublimall.</p>
            <p><strong>Warning!</strong> This passphrase will be showed in cleared text in input bar. After you enter your passphrase, the plugin will encrypt your archive and send it to server.</p>
        </div>
    </div>
{% endblock %}