Skip to content

Commit 6824866

Browse files
committed
Merge pull request 'Update Readme.md' from upd-readme into master
Reviewed-on: https://git.onlyoffice.com/ONLYOFFICE/onlyoffice-confluence-cloud/pulls/14
2 parents c5b9a40 + 6789fd3 commit 6824866

1 file changed

Lines changed: 67 additions & 43 deletions

File tree

README.md

Lines changed: 67 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,31 @@
1-
# ONLYOFFICE integration app for Confluence Cloud
1+
# ONLYOFFICE app for Confluence Cloud
22

3-
This integration app enables users to edit office documents in [Confluence Cloud](https://www.atlassian.com/software/confluence/premium) using ONLYOFFICE Docs.
3+
Welcome to the official repository for the ONLYOFFICE app for Confluence Cloud!
44

5-
## Features
5+
Edit, co-author, and manage office files right inside [Confluence Cloud](https://www.atlassian.com/software/confluence/premium) pages using [ONLYOFFICE Docs](https://www.onlyoffice.com/docs). Open documents, spreadsheets, presentations, and PDFs from page attachments — edit them in-place and keep your Confluence content and files in sync.
66

7-
The app allows to:
7+
<p align="center">
8+
<a href="https://marketplace.atlassian.com/apps/1218214/onlyoffice-connector-for-confluence?tab=overview&hosting=cloud">
9+
<img width="800" src="https://marketplace.atlassian.com/product-listing/files/d37cd602-344a-420c-b18c-997c7306ea8e?width=1840&height=900" alt="ONLYOFFICE for Confluence Cloud">
10+
</a>
11+
</p>
812

9-
* View and edit text documents, spreadsheets, and presentations.
10-
* Co-edit documents in real-time using two co-editing modes (Fast and Strict), Track Changes, comments, built-in chat.
13+
## Features ✨
1114

12-
Supported formats:
15+
- **Open & edit inside Confluence:** Launch ONLYOFFICE editors directly from page attachments.
16+
- **Real-time co-editing:** Collaborate with colleagues using Fast and Strict modes, plus track changes, comments, and built-in chat.
17+
- **Wide format support:** Edit and view popular office formats.
18+
- **In-place saving:** Changes overwrite the same attachment file (saved as the page attachment).
19+
- **Secure connections:** JWT token protection is used for authenticated, safe access.
20+
21+
### Supported formats 📚
1322

1423
**For viewing:**
1524

1625
* **WORD**: DOC, DOCM, DOCX, DOT, DOTM, DOTX, EPUB, FB2, FODT, HTM, HTML, MHT, MHTML, ODT, OTT, RTF, STW, SXW, TXT, WPS, WPT, XML
1726
* **CELL**: CSV, ET, ETT, FODS, ODS, OTS, SXC, XLS, XLSB, XLSM, XLSX, XLT, XLTM, XLTX
1827
* **SLIDE**: DPS, DPT, FODP, ODP, OTP, POT, POTM, POTX, PPS, PPSM, PPSX, PPT, PPTM, PPTX, SXI
19-
* **PDF**: DJVU, DOCXF, OFORM, OXPS, PDF, XPS
28+
* **PDF**: DJVU, OXPS, PDF, XPS
2029

2130
**For editing:**
2231

@@ -27,64 +36,66 @@ Supported formats:
2736

2837
## Installing ONLYOFFICE Docs
2938

30-
To be able to edit documents in Confluence Cloud, you will need an instance of ONLYOFFICE Docs (Document Server). You can install free Community version or scalable Enterprise Edition.
39+
To be able to edit documents in Confluence Cloud, you will need an instance of [ONLYOFFICE Docs](https://www.onlyoffice.com/docs) (Document Server). You can install free Community version or scalable Enterprise Edition.
3140

32-
To install free Community version, use [Docker](https://github.com/onlyoffice/Docker-DocumentServer) (recommended) or follow [these instructions](https://helpcenter.onlyoffice.com/installation/docs-community-install-ubuntu.aspx) for Debian, Ubuntu, or derivatives.
41+
To install **free Community version**, use [Docker](https://github.com/onlyoffice/Docker-DocumentServer) (recommended) or follow [these instructions](https://helpcenter.onlyoffice.com/docs/installation/docs-community-install-ubuntu.aspx) for Debian, Ubuntu, or derivatives.
3342

34-
To install Enterprise Edition, follow the instructions [here](https://helpcenter.onlyoffice.com/installation/docs-enterprise-index.aspx).
43+
To install **Enterprise Edition**, follow instructions [here](https://helpcenter.onlyoffice.com/docs/installation/enterprise).
3544

3645
Community Edition vs Enterprise Edition comparison can be found [here](#onlyoffice-docs-editions).
3746

38-
## Configuring the integration app
47+
Alternatively, you can opt for **ONLYOFFICE Docs Cloud** which doesn't require downloading and installation. To get ONLYOFFICE Docs Cloud, get started [here](https://www.onlyoffice.com/docs-registration).
48+
49+
## App configuration ⚙️
3950

40-
Administrators can configure ONLYOFFICE integration app via the Manage Apps section in Confluence Cloud (Apps -> Manage Apps -> Confluence cloud ONLYOFFICE integration app -> Configure). On the configuration page, set up:
51+
Administrators can configure ONLYOFFICE integration app via the **Manage Apps** section in Confluence Cloud (Apps -> Manage Apps -> ONLYOFFICE -> Configure). On the configuration page, set up:
4152

42-
* **Document Editing Service Address**: The URL of the installed ONLYOFFICE Document Server.
53+
* **Document Editing Service Address**: The URL of the installed ONLYOFFICE Docs (Document Server).
4354

44-
* **Secret key**: Enables JWT to protect your documents from unauthorized access (further information can be found [here](https://api.onlyoffice.com/editors/signature/)).
55+
* **Secret key**: Enables JWT to protect your documents from unauthorized access (further information can be found [here](https://api.onlyoffice.com/docs/docs-api/additional-api/signature/)).
4556

46-
* **JWT Header**.
57+
* **JWT Header**: Name of the header to pass the JWT in, if you use a custom header in your server
4758

48-
## Using ONLYOFFICE integration app for Confluence Cloud
59+
## App usage
4960

50-
In the Pages module, you can attach files to the created pages: open the right context menu, click on the Attachments item and upload a file from the device.
61+
In the Pages module, you can attach files to the created pages: open the right context menu, click on the Attachments item and upload a file from the device.
5162

5263
The uploaded file will appear in the Attachments list. To launch the editor, click **Edit in ONLYOFFICE**. The file opens in the same window. The changes made are saved in the same file.
5364

54-
If you try to open a file that is not supported by ONLYOFFICE Docs (for example, jpg), an error window will appear.
65+
> Note: If a file is not supported by ONLYOFFICE, the integration will show an error message.
5566
56-
## ONLYOFFICE Docs editions
67+
## ONLYOFFICE Docs editions
5768

5869
ONLYOFFICE offers different versions of its online document editors that can be deployed on your own servers.
5970

60-
**ONLYOFFICE Docs** packaged as Document Server:
71+
**ONLYOFFICE Docs** packaged as Document Server:
6172

62-
* Community Edition (`onlyoffice-documentserver` package)
63-
* Enterprise Edition (`onlyoffice-documentserver-ee` package)
73+
* Community Edition 🆓 (`onlyoffice-documentserver` package)
74+
* Enterprise Edition 🏢 (`onlyoffice-documentserver-ee` package)
6475

65-
The table below will help you make the right choice.
76+
The table below will help you to make the right choice.
6677

6778
| Pricing and licensing | Community Edition | Enterprise Edition |
6879
| ------------- | ------------- | ------------- |
69-
| | [Get it now](https://www.onlyoffice.com/download-docs.aspx?utm_source=github&utm_medium=cpc&utm_campaign=GitHubConfluenceCloud#docs-community) | [Start Free Trial](https://www.onlyoffice.com/download-docs.aspx?utm_source=github&utm_medium=cpc&utm_campaign=GitHubConfluenceCloud#docs-enterprise) |
70-
| Cost | FREE | [Go to the pricing page](https://www.onlyoffice.com/docs-enterprise-prices.aspx?utm_source=github&utm_medium=cpc&utm_campaign=GitHubConfluenceCloud) |
80+
| | [Get it now](https://www.onlyoffice.com/download-community?utm_source=github&utm_medium=cpc&utm_campaign=GitHubConfluenceCloud#docs-community) | [Start Free Trial](https://www.onlyoffice.com/download?utm_source=github&utm_medium=cpc&utm_campaign=GitHubConfluenceCloud#docs-enterprise) |
81+
| Cost | FREE | [Go to the pricing page](https://www.onlyoffice.com/docs-enterprise-prices?utm_source=github&utm_medium=cpc&utm_campaign=GitHubConfluenceCloud) |
7182
| Simultaneous connections | up to 20 maximum | As in chosen pricing plan |
7283
| Number of users | up to 20 recommended | As in chosen pricing plan |
7384
| License | GNU AGPL v.3 | Proprietary |
7485
| **Support** | **Community Edition** | **Enterprise Edition** |
75-
| Documentation | [Help Center](https://helpcenter.onlyoffice.com/installation/docs-community-index.aspx) | [Help Center](https://helpcenter.onlyoffice.com/installation/docs-enterprise-index.aspx) |
76-
| Standard support | [GitHub](https://github.com/ONLYOFFICE/DocumentServer/issues) or paid | One year support included |
86+
| Documentation | [Help Center](https://helpcenter.onlyoffice.com/docs/installation/community) | [Help Center](https://helpcenter.onlyoffice.com/docs/installation/enterprise) |
87+
| Standard support | [GitHub](https://github.com/ONLYOFFICE/DocumentServer/issues) or paid | 1 or 3 years support included |
7788
| Premium support | [Contact us](mailto:sales@onlyoffice.com) | [Contact us](mailto:sales@onlyoffice.com) |
7889
| **Services** | **Community Edition** | **Enterprise Edition** |
7990
| Conversion Service | + | + |
8091
| Document Builder Service | + | + |
8192
| **Interface** | **Community Edition** | **Enterprise Edition** |
82-
| Tabbed interface | + | + |
83-
| Dark theme | + | + |
84-
| 125%, 150%, 175%, 200% scaling | + | + |
85-
| White Label | - | - |
86-
| Integrated test example (node.js) | + | + |
87-
| Mobile web editors | - | +* |
93+
| Tabbed interface | + | + |
94+
| Dark theme | + | + |
95+
| 125%, 150%, 175%, 200% scaling | + | + |
96+
| White Label | - | - |
97+
| Integrated test example (node.js) | + | + |
98+
| Mobile web editors | - | +* |
8899
| **Plugins & Macros** | **Community Edition** | **Enterprise Edition** |
89100
| Plugins | + | + |
90101
| Macros | + | + |
@@ -98,8 +109,8 @@ The table below will help you make the right choice.
98109
| **Document Editor features** | **Community Edition** | **Enterprise Edition** |
99110
| Font and paragraph formatting | + | + |
100111
| Object insertion | + | + |
101-
| Adding Content control | + | + |
102-
| Editing Content control | + | + |
112+
| Adding Content control | + | + |
113+
| Editing Content control | + | + |
103114
| Layout tools | + | + |
104115
| Table of contents | + | + |
105116
| Navigation panel | + | + |
@@ -111,9 +122,9 @@ The table below will help you make the right choice.
111122
| Functions, formulas, equations | + | + |
112123
| Table templates | + | + |
113124
| Pivot tables | + | + |
114-
| Data validation | + | + |
125+
| Data validation | + | + |
115126
| Conditional formatting | + | + |
116-
| Sparklines | + | + |
127+
| Sparklines | + | + |
117128
| Sheet Views | + | + |
118129
| **Presentation Editor features** | **Community Edition** | **Enterprise Edition** |
119130
| Font and paragraph formatting | + | + |
@@ -123,16 +134,29 @@ The table below will help you make the right choice.
123134
| Presenter mode | + | + |
124135
| Notes | + | + |
125136
| **Form creator features** | **Community Edition** | **Enterprise Edition** |
126-
| Adding form fields | + | + |
137+
| Adding form fields | + | + |
127138
| Form preview | + | + |
128139
| Saving as PDF | + | + |
129-
| **Working with PDF** | **Community Edition** | **Enterprise Edition** |
130-
| Text annotations (highlight, underline, cross out) | + | + |
140+
| **PDF Editor features** | **Community Edition** | **Enterprise Edition** |
141+
| Text editing and co-editing | + | + |
142+
| Work with pages (adding, deleting, rotating) | + | + |
143+
| Inserting objects (shapes, images, hyperlinks, etc.) | + | + |
144+
| Text annotations (highlight, underline, cross out, stamps) | + | + |
131145
| Comments | + | + |
132146
| Freehand drawings | + | + |
133147
| Form filling | + | + |
134-
| | [Get it now](https://www.onlyoffice.com/download-docs.aspx?utm_source=github&utm_medium=cpc&utm_campaign=GitHubConfluenceCloud#docs-community) | [Start Free Trial](https://www.onlyoffice.com/download-docs.aspx?utm_source=github&utm_medium=cpc&utm_campaign=GitHubConfluenceCloud#docs-enterprise) |
148+
| | [Get it now](https://www.onlyoffice.com/download-community?utm_source=github&utm_medium=cpc&utm_campaign=GitHubConfluenceCloud#docs-community) | [Start Free Trial](https://www.onlyoffice.com/download?utm_source=github&utm_medium=cpc&utm_campaign=GitHubConfluenceCloud#docs-enterprise) |
135149

136150
\* If supported by DMS.
137151

138-
In case of technical problems, the best way to get help is to submit your issues [here](https://github.com/ONLYOFFICE/onlyoffice-confluence-cloud/issues). Alternatively, you can contact ONLYOFFICE team on [forum.onlyoffice.com](https://forum.onlyoffice.com/).
152+
## Need help? User Feedback and Support 💡
153+
154+
* **🐞 Found a bug?** Please report it by creating an [issue](https://github.com/ONLYOFFICE/onlyoffice-confluence-cloud/issues).
155+
* **❓ Have a question?** Ask our community and developers on the [ONLYOFFICE Forum](https://community.onlyoffice.com).
156+
* **👨‍💻 Need help for developers?** Check our [API documentation](https://api.onlyoffice.com).
157+
* **💡 Want to suggest a feature?** Share your ideas on our [feedback platform](https://feedback.onlyoffice.com/forums/966080-your-voice-matters).
158+
159+
---
160+
<p align="center">
161+
Made with ❤️ by the <a href="https://www.onlyoffice.com/">ONLYOFFICE Team</a>
162+
</p>

0 commit comments

Comments
 (0)