Search 1.9 billion lines of Odoo code on GitHub
document_sftp
<a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.svg">
</a>
<a name="sftp"></a>
<h2>SFTP</h2>
<p>This module allows you to access your data (= documents attached to records)
via SFTP. There will be different virtual roots to get your browsing started,
for the time being, there's only one map <cite>By model</cite> that lets you browse ids
of the records of the different models.</p>
<a name="installation"></a>
<h3>Installation</h3>
<p>To install this module, you need to:</p>
<ol class="arabic simple">
<li>install paramiko. You need version 2.0 or higher</li>
<li>install the module. It will generate a new host key during installation</li>
</ol>
<a name="configuration"></a>
<h3>Configuration</h3>
<p>To configure this module, you need to:</p>
<ol class="arabic simple">
<li>be sure there's a proper hostkey in config parameter <code>document_sftp.hostkey</code></li>
<li>add some authorized key on the users' form who should be allowed to login via SFTP</li>
</ol>
<a name="usage"></a>
<h3>Usage</h3>
<p>To use this module, you need to:</p>
<ol class="arabic simple">
<li>add some keys to your user's authorized key field</li>
<li>say <code>sftp -p 2222 $yourodoohost</code> and browse through the possibilities</li>
<li>when you found what you want, say <code>sshfs -p 2222 "admin@localhost:By model/res.company/1" $yourmountpoint</code> to see all attachments of your main company in <code>$yourmountpoint</code></li>
<li>pay someone to implement locking (see below) in order to be able to write on this</li>
</ol>
<a class="reference external image-reference" href="https://runbot.odoo-community.org/runbot/118/8.0"><img alt="Try me on Runbot" src="https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas" /></a>
<a name="known-issues-roadmap"></a>
<h3>Known issues / Roadmap</h3>
<ul class="simple">
<li>implement writing. This is not trivial, because we need some concept of locking, UI for that and take care of some corner cases</li>
<li>allow to restrict actions on SFTP that are allowed normally (because <code>rf -rf $yourmountpoint/</code> can become a serious problem)</li>
<li>should support directories</li>
<li>implement some other useful virtual roots (Mails, By Directory, By name, ...)
This should look like symlinks to the rigid designator (model+id) from the point of view of the user.</li>
<li>with this, <cite>auth_ssh</cite> should be simple to implement enabling passwordless logins for your scripts</li>
<li>if you want to see error messages from the SFTP server thread, use <code>--log-handler=paramiko:DEBUG</code></li>
</ul>
<a name="bug-tracker"></a>
<h3>Bug Tracker</h3>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/knowledge/issues">GitHub Issues</a>. In case of trouble, please
check there if your issue has already been reported. If you spotted it first,
help us smashing it by providing a detailed and welcomed feedback.</p>
<a name="credits"></a>
<h3>Credits</h3>
<a name="images"></a>
<h4>Images</h4>
<ul class="simple">
<li>Odoo Community Association: <a class="reference external" href="https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg">Icon</a>.</li>
</ul>
<a name="contributors"></a>
<h4>Contributors</h4>
<ul class="simple">
<li>Holger Brunn <<a class="reference external" href="mailto:hbrunn@therp.nl">hbrunn@therp.nl</a>></li>
</ul>
<p>Do not contact contributors directly about help with questions or problems concerning this addon, but use the <a class="reference external" href="mailto:community@mail.odoo.com">community mailing list</a> or the <a class="reference external" href="https://odoo-community.org/groups">appropriate specialized mailinglist</a> for help, and the bug tracker linked in <a class="reference internal" href="#bug-tracker">Bug Tracker</a> above for technical issues.</p>
<a name="maintainer"></a>
<h4>Maintainer</h4>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>This module is maintained by the OCA.</p>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.</p>
<p>To contribute to this module, please visit <a class="reference external" href="https://odoo-community.org">https://odoo-community.org</a>.</p>