Skip to content

emacsorphanage/docean

Repository files navigation

Emacs Logo

docean.el

Interact with DigitalOcean from Emacs.


License GPLv3 MELPA

Note: docean.el uses the API v2.0 of DigitalOcean.

docean.el enables an easy interaction with DigitalOcean from Emacs.

Features

  • Show list of droplets.
  • Perform droplet actions.
  • Show actions performed by an account.

Usage

In order to use docean.el you need to generate API key for your Digital Ocean account. Go to https://cloud.digitalocean.com/settings/applications to generate your API key. docean.el can find your API key in the following ways:

  • Add a .authinfo.gpg entry with the host set to "api.digitalocean.com" and password set to the API key.
  • Add (setq docean-oauth-token "mytoken") to your init.el
  • Set the environment variable DO_API_TOKEN.

To show your droplets you can use M-x docean-droplet-list.

TODO

  • Handle meta and links in API responses.

Customization Documentation

docean-oauth-token

Oauth bearer token to interact with DigitalOcean api.

docean-default-per-page

Default per_page argument used in list requests.

Function and Macro Documentation

(docean-oauth-token)

Return the configured DigitalOcean token.

(docean-reboot-droplet ID)

Reboot a droplet identified by ID.

(docean-power-cicle-droplet ID)

Power cicle a droplet identified by ID.

(docean-shutdown-droplet ID)

Shutdown a droplet identified by ID.

(docean-power-off-droplet ID)

Power off a droplet identified by ID.

(docean-power-on-droplet ID)

Reboot a droplet identified by ID.

(docean-password-reset-droplet ID)

Reset password a droplet identified by ID.

(docean-enable-ipv6-droplet ID)

Enable ipv6 to a droplet identified by ID.

(docean-disable-backups-droplet ID)

Disable backups a droplet identified by ID.

(docean-enable-private-networking-droplet ID)

Enable private networking a droplet identified by ID.

(docean-rename-droplet ID &optional NAME)

Rename a droplet with ID and NAME.

(docean-snapshot-droplet ID &optional NAME)

Snapshot a droplet with ID and NAME.

(docean-droplet-list)

Show user droplets.

(docean-refetch-droplets)

Refetch droplets information.

(docean-action-list)

Show user actions.

(docean-refetch-actions)

Refetch actions information.


Markdown README file generated by make-readme-markdown.el