Skip to main content

Access your documents via SFTP

Project description

License: AGPL-3


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 By model that lets you browse ids of the records of the different models.


To install this module, you need to:

  1. install paramiko. You need version 2.0 or higher

  2. install the module. It will generate a new host key during installation


To configure this module, you need to:

  1. be sure there’s a proper hostkey in config parameter document_sftp.hostkey

  2. add some authorized key on the users’ form who should be allowed to login via SFTP


To use this module, you need to:

  1. add some keys to your user’s authorized key field

  2. say sftp -p 2222 $yourodoohost and browse through the possibilities

  3. when you found what you want, say sshfs -p 2222 "admin@localhost:By model/" $yourmountpoint to see all attachments of your main company in $yourmountpoint

  4. pay someone to implement locking (see below) in order to be able to write on this

Try me on Runbot

Known issues / Roadmap

  • implement writing. This is not trivial, because we need some concept of locking, UI for that and take care of some corner cases

  • allow to restrict actions on SFTP that are allowed normally (because rf -rf $yourmountpoint/ can become a serious problem)

  • should support directories

  • 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.

  • with this, auth_ssh should be simple to implement enabling passwordless logins for your scripts

  • if you want to see error messages from the SFTP server thread, use --log-handler=paramiko:DEBUG

Bug Tracker

Bugs are tracked on GitHub Issues. 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.



  • Odoo Community Association: Icon.


Do not contact contributors directly about help with questions or problems concerning this addon, but use the community mailing list or the appropriate specialized mailinglist for help, and the bug tracker linked in Bug Tracker above for technical issues.


Odoo Community Association

This module is maintained by the OCA.

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.

To contribute to this module, please visit

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page