Nanome Vault will start a web server. Other people can upload molecules or other files to it, and they will appear in Nanome. This works for both Nanome & Nanome Curie (Quest edition).
Supports Nanome v1.16 and up. For previous versions, please check out Vault v1.2.1
Vault natively supports:
- Molecules:
.cif.mol2.pdb.sdf.smiles.xyz - 3rd party files:
.ccp4.dsn6.dx.mae.moe.pqr.pse.psf - Documents:
.pdf - Trajectories:
.dcd.gro.trr.xtc - Images:
.png.jpg - Spatial Recordings:
.nanosr - Workspaces:
.nanome - Macros:
.lua
Using Gotenberg, the following are converted to PDF:
- Documents:
.doc.docx.txt.rtf.odt - Presentations:
.ppt.pptx.odp
To run Vault in a Docker container:
$ cd docker
$ ./build.sh
$ ./deploy.sh -a <plugin_server_address> [optional args]-
-c urlor--converter-url urlThe url of the Gotenberg service to use for conversion. Defaults to
http://vault-converter:3000for use inside Docker. Example:-c http://localhost:3000 -
--enable-authEnables enforced authentication, preventing users from accessing files in the Web UI unless they are logged in.
-
--httpsEnable HTTPS using a self-signed certificate. If port is not set, port will default to 443.
-
--keep-files-days daysAutomatically delete files that haven't been accessed in a given number of days. Example: to delete untouched files after 2 weeks:
--keep-files-days 14 -
--ui-message messageAdd a custom message to the web UI, appearing right under the "Nanome Vault" at the top of the page. There is an issue with spaces in the message and passing the arg to docker, so instead replace any space in the message with an underscore and it will be converted back into a space. Example
--ui-message "Hello,_Vault!" -
-u urlor--url urlThe url to display in the plugin for accessing the Web UI. Example:
-u vault.example.com -
--user-storage sizeThe size of the user storage, defaults to unlimited. Supports suffixes:
k,m,g. Example:--user-storage 1g. When user storage is exceeded, new files will fail to upload and a message will be displayed. -
-w portor--web-port portThe port to use for the Web UI. Example:
-w 8080Some OSes prevent the default port
80from being used without elevated permissions, so this option may be used to change to an allowed port.
In Nanome:
- Activate Plugin
- Click Run
- Open your web browser, go to "127.0.0.1" (or your computer's IP address from another computer), and add supported files. Your files will appear in Nanome.
To run Vault plugin with autoreload:
$ python3 -m pip install -r requirements.txt
$ python3 run.py -r -a <plugin_server_address> [optional args]To run Vault server with autoreload:
$ cd server
$ yarn install
$ yarn run devNote: when running outside of Docker, you will need to replace "vault-server" in VaultManager.py with "localhost".
To run the WebUI with autoreload:
$ cd server/ui
$ yarn install
$ yarn run serveNote: this will only work if the Vault server is running on the default port (without using the -w option). To work with a non-default port, change the proxy settings in vue.config.js.
MIT