Skip to content

Commit 7b9b489

Browse files
LinneySLinneyS
committed
Merge pull request 'Update README.md' from upd-readme into develop
Reviewed-on: https://git.onlyoffice.com/ONLYOFFICE/onlyoffice-discourse/pulls/2
2 parents 354905b + 9c64b4d commit 7b9b489

File tree

1 file changed

+167
-3
lines changed

1 file changed

+167
-3
lines changed

‎README.md‎

Lines changed: 167 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,169 @@
1-
# **Plugin Name** Plugin
1+
# ONLYOFFICE plugin for Discourse
22

3-
**Plugin Summary**
3+
Welcome to the official repository for the **ONLYOFFICE plugin for Discourse**!
4+
It brings the power of [ONLYOFFICE Docs](https://www.onlyoffice.com/docs) right to your [Discourse](https://www.discourse.org/) enabling work with office files in topics and replies.
45

5-
For more information, please see: **url to meta topic**
6+
## Features ✨
7+
8+
The plugin allows Discourse users to:
9+
10+
* ✍️ Create and edit [text documents](https://www.onlyoffice.com/word-processor), [spreadsheets](https://www.onlyoffice.com/sheets), [presentations](https://www.onlyoffice.com/slides), and [PDFs](https://www.onlyoffice.com/pdf-editor) right inside Discourse.
11+
* 👥 Collaborate on documents in real time.
12+
* 📂 Convert and download files.
13+
* 🔒 Manage file access permissions.
14+
15+
## Running ONLYOFFICE Docs
16+
17+
You'll need an instance of [ONLYOFFICE Docs](https://www.onlyoffice.com/docs).
18+
19+
### ☁️ Option 1: ONLYOFFICE Docs Cloud
20+
No installation needed — just [register here](https://www.onlyoffice.com/docs-registration) and get instant access.
21+
Your registration email includes all required connection details, including the **Document Server address** and **JWT credentials**.
22+
23+
### 🏠 Option 2: Self-hosted ONLYOFFICE Docs
24+
Install ONLYOFFICE Docs on your own infrastructure for full control.
25+
You have two main choices for the ONLYOFFICE Document Server:
26+
27+
* **Community Edition (Free)**: Ideal for small teams and personal use.
28+
* The **recommended** installation method is [Docker](https://github.com/onlyoffice/Docker-DocumentServer).
29+
* To install it on Debian, Ubuntu, or other derivatives, click [here](https://helpcenter.onlyoffice.com/docs/installation/docs-community-install-ubuntu.aspx).
30+
* **Enterprise Edition**: Provides scalability for larger organizations.
31+
To install, click [here](https://helpcenter.onlyoffice.com/docs/installation/enterprise).
32+
33+
Community Edition vs Enterprise Edition comparison can be found [here](#onlyoffice-docs-editions).
34+
35+
## Plugin configuration ⚙️
36+
37+
Navigate to the **Admin** section in the left panel.
38+
On the page that opens, locate the **Plugins** section in the left panel and click on **Installed plugins**.
39+
From the list, find **ONLYOFFICE Discourse** and click **Settings**.
40+
41+
Enter the following details:
42+
43+
- **ONLYOFFICE Docs address**: The URL of your Docs instance (cloud or on-premises).
44+
- **ONLYOFFICE Docs secret key**: Enables secure token-based access to documents.
45+
[Learn more](https://api.onlyoffice.com/docs/docs-api/additional-api/signature/)
46+
- **JWT Header**: If you have custom header naming in your Docs setup, enter it here.
47+
48+
To ensure the ONLYOFFICE plugin functions properly, enable the **Auto authorize extensions** setting.
49+
By default, Discourse limits the list of allowed attachment formats.
50+
Enabling this setting automatically expands the list of authorized extensions in Discourse, allowing users to attach and open files in the editor via the ONLYOFFICE plugin.
51+
52+
## Plugin usage
53+
54+
### Creating and editing files ✍️
55+
56+
When adding a topic or comment, you can create a file (DOCX, XLSX, PPTX, or PDF) by clicking the ONLYOFFICE icon and selecting the desired format.
57+
58+
The created file is automatically attached to the topic or reply.
59+
Once published, the file appears in the post, and clicking its name opens a pop-up with the following actions:
60+
61+
- **Edit with ONLYOFFICE:** Open the file in ONLYOFFICE editors for seamless editing.
62+
The file creator is granted editing rights by default.
63+
- **Download:** Save the file directly to your device.
64+
- **Manage Permissions:** Adjust access rights for the file.
65+
- **Convert:** Convert the file into a different format of your choice.
66+
67+
### File conversion 🔄
68+
69+
Save your file in the format of your choice.
70+
Simply click the **Convert** button, select the desired format from the list, and the file will be downloaded directly to your device.
71+
72+
### Managing file access permissions 🔐
73+
74+
By default, only the file owner (the post author) has editing rights, while other users can view the file.
75+
76+
To grant editing permissions to another user, click **Manage Permissions**, enter the username in the search bar, and click **Add Permissions**.
77+
Users with granted access will appear in the **Current Permissions** section within the same window.
78+
79+
## ONLYOFFICE Docs editions
80+
81+
Self-hosted ONLYOFFICE Docs offers different versions of its online document editors that can be deployed on your own servers.
82+
83+
**ONLYOFFICE Docs** packaged as Document Server:
84+
85+
* Community Edition 🆓 (`onlyoffice-documentserver` package)
86+
* Enterprise Edition 🏢 (`onlyoffice-documentserver-ee` package)
87+
88+
The table below will help you to make the right choice.
89+
90+
| Pricing and licensing | Community Edition | Enterprise Edition |
91+
| ------------- | ------------- | ------------- |
92+
| | [Get it now](https://www.onlyoffice.com/download-community?utm_source=github&utm_medium=cpc&utm_campaign=GitHubDiscourse#docs-community) | [Start Free Trial](https://www.onlyoffice.com/download?utm_source=github&utm_medium=cpc&utm_campaign=GitHubDiscourse#docs-enterprise) |
93+
| Cost | FREE | [Go to the pricing page](https://www.onlyoffice.com/docs-enterprise-prices?utm_source=github&utm_medium=cpc&utm_campaign=GitHubDiscourse) |
94+
| Simultaneous connections | up to 20 maximum | As in chosen pricing plan |
95+
| Number of users | up to 20 recommended | As in chosen pricing plan |
96+
| License | GNU AGPL v.3 | Proprietary |
97+
| **Support** | **Community Edition** | **Enterprise Edition** |
98+
| Documentation | [Help Center](https://helpcenter.onlyoffice.com/docs/installation/community) | [Help Center](https://helpcenter.onlyoffice.com/docs/installation/enterprise) |
99+
| Standard support | [GitHub](https://github.com/ONLYOFFICE/DocumentServer/issues) or paid | 1 or 3 years support included |
100+
| Premium support | [Contact us](mailto:sales@onlyoffice.com) | [Contact us](mailto:sales@onlyoffice.com) |
101+
| **Services** | **Community Edition** | **Enterprise Edition** |
102+
| Conversion Service | + | + |
103+
| Document Builder Service | + | + |
104+
| **Interface** | **Community Edition** | **Enterprise Edition** |
105+
| Tabbed interface | + | + |
106+
| Dark theme | + | + |
107+
| 125%, 150%, 175%, 200% scaling | + | + |
108+
| White Label | - | - |
109+
| Integrated test example (node.js) | + | + |
110+
| Mobile web editors | - | +* |
111+
| **Plugins & Macros** | **Community Edition** | **Enterprise Edition** |
112+
| Plugins | + | + |
113+
| Macros | + | + |
114+
| **Collaborative capabilities** | **Community Edition** | **Enterprise Edition** |
115+
| Two co-editing modes | + | + |
116+
| Comments | + | + |
117+
| Built-in chat | + | + |
118+
| Review and tracking changes | + | + |
119+
| Display modes of tracking changes | + | + |
120+
| Version history | + | + |
121+
| **Document Editor features** | **Community Edition** | **Enterprise Edition** |
122+
| Font and paragraph formatting | + | + |
123+
| Object insertion | + | + |
124+
| Adding Content control | + | + |
125+
| Editing Content control | + | + |
126+
| Layout tools | + | + |
127+
| Table of contents | + | + |
128+
| Navigation panel | + | + |
129+
| Mail Merge | + | + |
130+
| Comparing Documents | + | + |
131+
| **Spreadsheet Editor features** | **Community Edition** | **Enterprise Edition** |
132+
| Font and paragraph formatting | + | + |
133+
| Object insertion | + | + |
134+
| Functions, formulas, equations | + | + |
135+
| Table templates | + | + |
136+
| Pivot tables | + | + |
137+
| Data validation | + | + |
138+
| Conditional formatting | + | + |
139+
| Sparklines | + | + |
140+
| Sheet Views | + | + |
141+
| **Presentation Editor features** | **Community Edition** | **Enterprise Edition** |
142+
| Font and paragraph formatting | + | + |
143+
| Object insertion | + | + |
144+
| Transitions | + | + |
145+
| Animations | + | + |
146+
| Presenter mode | + | + |
147+
| Notes | + | + |
148+
| **Form creator features** | **Community Edition** | **Enterprise Edition** |
149+
| Adding form fields | + | + |
150+
| Form preview | + | + |
151+
| Saving as PDF | + | + |
152+
| **PDF Editor features** | **Community Edition** | **Enterprise Edition** |
153+
| Text editing and co-editing | + | + |
154+
| Work with pages (adding, deleting, rotating) | + | + |
155+
| Inserting objects (shapes, images, hyperlinks, etc.) | + | + |
156+
| Text annotations (highlight, underline, cross out, stamps) | + | + |
157+
| Comments | + | + |
158+
| Freehand drawings | + | + |
159+
| Form filling | + | + |
160+
| | [Get it now](https://www.onlyoffice.com/download-community?utm_source=github&utm_medium=cpc&utm_campaign=GitHubDiscourse#docs-community) | [Start Free Trial](https://www.onlyoffice.com/download?utm_source=github&utm_medium=cpc&utm_campaign=GitHubDiscourse#docs-enterprise) |
161+
162+
\* If supported by DMS.
163+
164+
## Need help? User Feedback and Support 💡
165+
166+
* **🐞 Found a bug?** Please report it by creating an [issue](https://github.com/ONLYOFFICE/onlyoffice-discourse/issues).
167+
* **❓ Have a question?** Ask our community and developers on the [ONLYOFFICE Forum](https://community.onlyoffice.com).
168+
* **👨‍💻 Need help for developers?** Check our [API documentation](https://api.onlyoffice.com).
169+
* **💡 Want to suggest a feature?** Share your ideas on our [feedback platform](https://feedback.onlyoffice.com/forums/966080-your-voice-matters).

0 commit comments

Comments
 (0)