History

Henrik Lissner 88844e9cec docs: simplify internal docs links Fewer links means less confusion. - Merge doom-issue and doom-commit links into doom-ref (for auto-linking Issue/PR/commit references). - Merge doom-module-source and doom-docs-source links into doom-source. - Rename doom-report-issue to doom-report. - Use '!' as the icon for module issues link. - Remove doom-repo (replaced with "doom:*" in :lang org module). - Add doomdir and emacsdir links to :lang org module.		2021-11-21 20:04:28 +01:00
..
config.el	fix(upload): deploy force on explicit save	2021-11-18 19:08:21 +01:00
packages.el	Bump :tools	2021-07-09 17:42:18 -04:00
README.org	docs: simplify internal docs links	2021-11-21 20:04:28 +01:00

README.org

:tools upload

Description
- Maintainers
- Module flags
- Packages
- Hacks
- Changelog
Installation
Usage
Configuration
Troubleshooting
- root-local and root-remote must match
Frequently asked questions
Appendix

← Back to module index ! Issues ↖ Github ± Suggest edits ? Help

Description unfold

Uses ssh-deploy to map a local folder to a remote one.

From the ssh-deploy README:

The ssh-deploy plug-in for Emacs makes it possible to effortlessly deploy local files and directories to remote hosts via Tramp (including but not limited to SSH, SFTP, FTP). It tries to provide functions that can be easily used by custom scripts.

The idea for this plug-in was to mimic the behavior of PhpStorm deployment functionality.

Maintainers

@hlissner

Become a maintainer?

Module flags

This module has no flags.

Packages

ssh-deploy

Hacks

No hacks documented for this module.

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module has no external requirements.

TODO Usage

🔨 This module's usage documentation is incomplete. Complete it?

Uses ssh-deploy to map a local folder to a remote one. Set ssh-deploy-root-remote and ssh-deploy-root-local in a .dir-locals.el file to establish this mapping. E.g.

((nil . ((ssh-deploy-root-local . "/local/path/to/project")
         (ssh-deploy-root-remote . "/ssh:user@server:/remote/project/")
         (ssh-deploy-on-explicit-save . t))))

📌 ssh-deploy-root-local is optional, and will resort to doom-project-root if unspecified.

TODO Configuration

🔨 This module's configuration documentation is incomplete. Complete it?

Check out Deployment configuration examples for some ideas of what's possible.

Troubleshooting

`root-local` and `root-remote` must match

The final directory names much match:

((nil . ((ssh-deploy-root-local . "/local/path/to/example-project")
         (ssh-deploy-root-remote . "/ssh:user@server:/remote/example-project/")

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

🔨 This module has no appendix yet. Write one?