ONLYOFFICE¶
Operating System:
Terminal:
Shell:
Editor:
Package Manager:
Programming Language:
Database:
ONLYOFFICE Docs is a browser-based editor for text documents, spreadsheets, presentations, forms, and more. See more here. It supports the creation and editing of many different document types, including commercial file types such as .docx, .pptx., .xlsx.
Note
ONLYOFFICE Docs on UCloud is not intended to be used for real-time collaboration on documents.
Below, the term document refers to a file of any of the supported types.
Working with Documents¶
All document operations are done by the ucloud user.
Access documents¶
If the user wants to edit documents stored on UCloud, they must place all the documents in a single folder and mount it using the Files folder optional parameter. When the job starts and the interface is opened, the documents will be available for editing inside the interface.
If the user mounts an empty folder to the Files folder optional parameter, all documents created inside the interface will be stored in the mounted folder.
If the job is started without setting the Files folder optional parameter, the documents created inside the interface will be stored in /work/files.
Note
If a non-empty folder is mounted to Files folder, the documents will be available inside the interface. Refresh the page if they do not show up immediately.
Create new documents¶
To create a new, empty document, click the desired file type under Create new in the interface. It is possible to create text documents, spreadsheets, presentations, and PDF forms.
When a document is created, a corresponding folder is also created for keeping track of the document's version history. The user can disable the synchronization of these folders to the file storage during job submission by setting the optional parameter Exclude directories to true.
Upload documents¶
The user can upload documents from the their local machine using the Upload file button.
Edit documents¶
When clicking a document from the list of documents, the appropriate editor will open in a new tab.
Changes made in a document are only written to the file storage when the corresponding editor tab is closed.
Convert documents¶
To convert a document to a different, compatible file type (e.g., convert a .docx file to a .txt file), the user must first click on it to open the editor tab. From inside the editor, click on Save Copy As and select the desired file type.
Download documents¶
Documents can be downloaded from the interface by clicking the Download button under Action.
Alternatively, the user can click File > Download As inside an editor to download the file.
Delete documents¶
A document can be deleted from the interface by clicking the Delete button under Action. This will also delete the document's version history folder.
Important
When a document is deleted from the interface, it will be immediately and irrecoverably deleted from the file storage. In other words, it is not moved to a Trash folder or similar.
Rename documents¶
It is not possible to rename documents directly from the interface. Instead, the user can use the following command from the job's terminal interface:
$ rename_document <old-name> <new-name>
The command can only be used if the Exclude directories optional parameter is set to true.
Note
Renaming a file in this way will not rename its version history folder. This means that the new document is effectively disconnected from its old folder.
Initialization¶
For information on how to use the Initialization parameter, please refer to the Initialization - Bash script section of the documentation.
Contents