Skip to content

Commit 82f1c15

Browse files
committed
docs: add security
1 parent 30b6402 commit 82f1c15

24 files changed

+389
-0
lines changed
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
description: Guidelines when writing documentation.
3+
globs:
4+
alwaysApply: false
5+
---
6+
7+
8+
- Follow Google Style guide when writting documentation.
9+
- Use parenthesis instead of em-dashes.
10+
- Write for developers, avoid marketing buzzwords and bluff.

docs/release-notes.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Release notes
2+
3+
Stay up-to-date with the latest features, improvements, and updates to PushFeedback and its ecosystem of packages.
4+
5+
## Product updates
6+
7+
For comprehensive release notes and product announcements, visit our [Blog](http://pushfeedback.com/blog?category=release-notes). We publish bimonthly updates highlighting the most relevant product features and improvements.
8+
9+
## Package updates
10+
11+
### Core packages
12+
13+
<section className="row">
14+
<article className="docCardListItem_W1sv col col--6">
15+
<a className="card padding--lg cardContainer_fWXF" href="#">
16+
<h2 className="text--truncate cardTitle_rnsV" title="pushfeedback-search">📦️ pushfeedback</h2>
17+
<p className="text--truncate cardDescription_PWke" title="Core-chatbot and search widget package">Core-widget package</p>
18+
<div className="badge badge--secondary">Coming soon</div>
19+
</a>
20+
</article>
21+
</section>
22+
23+
### Integrations
24+
25+
<section className="row">
26+
<article className="docCardListItem_W1sv col col--6">
27+
<a className="card padding--lg cardContainer_fWXF" href="https://github.com/TechDocsStudio/pushfeedback-react">
28+
<h2 className="text--truncate cardTitle_rnsV" title="pushfeedback-react">⚛️ pushfeedback-react</h2>
29+
<p className="text--truncate cardDescription_PWke" title="AI chatbot component for React applications">Feedback widget for React applications</p>
30+
<div className="badge badge badge--secondary">CHANGELOG</div>
31+
</a>
32+
</article>
33+
34+
<article className="docCardListItem_W1sv col col--6">
35+
<a className="card padding--lg cardContainer_fWXF" href="https://github.com/TechDocsStudio/docusaurus-pushfeedback/blob/master/CHANGELOG.md">
36+
<h2 className="text--truncate cardTitle_rnsV" title="docusaurus-pushfeedback">🦖 docusaurus-pushfeedback</h2>
37+
<p className="text--truncate cardDescription_PWke" title="Feedback plugin for Docusaurus sites">Feedback plugin for Docusaurus sites</p>
38+
<div className="badge badge--secondary">CHANGELOG</div>
39+
</a>
40+
</article>
41+
42+
<article className="docCardListItem_W1sv col col--6">
43+
<a className="card padding--lg cardContainer_fWXF" href="https://github.com/TechDocsStudio/sphinx-pushfeedback/blob/master/CHANGELOG.rst">
44+
<h2 className="text--truncate cardTitle_rnsV" title="sphinx-pushfeedback">🐍 sphinx-pushfeedback</h2>
45+
<p className="text--truncate cardDescription_PWke" title="Official Feedback extension for Sphinx documentation">Feedback extension for Sphinx documentation</p>
46+
<div className="badge badge--secondary">CHANGELOG</div>
47+
</a>
48+
</article>
49+
50+
</section>

docs/security/_category_.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Security",
3+
"position": 6,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Comprehensive security insights and safeguards for a secure, compliant chatbot experience."
7+
}
8+
}

docs/security/checklist.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Production checklist
6+
7+
Use this checklist to confirm that essential security measures are configured for optimal protection on the PushFeedback widget before going to production. Each item provides straightforward actions to help you secure data, control access, and maintain compliance.
8+
9+
## For widget integrations
10+
11+
:::info Widget Integrations Only
12+
The following steps apply only to implementations using the **feedback widget**.
13+
:::
14+
15+
- [ ] **Restrict allowed domains**: List only the domains authorized to host your feedback widget in **Projects** > **Settings** > **Allowed domains**. This restricts embedding to approved sites, helping prevent unauthorized access.
16+
17+
- [ ] **Enable two-factor authentication (2FA)**: Navigate to **My Account** > **Profile** and enable 2FA for all accounts with access to the dashboard to enhance access security.
18+
19+
- [ ] **Configure data privacy (optional)**: Choose whether to display a custom terms and conditions modal in the footer. For more information, see [Layout customization](../customization/layout.mdx).
20+
21+
22+
## For API integrations
23+
24+
:::info API Integrations Only
25+
The following steps apply only to direct integrations using the **Enterprise API**. These steps are not necessary for widget-based implementations.
26+
:::
27+
28+
- [ ] **Enable bearer authentication**: Ensure each API client request includes a bearer token in the header as follows: `Authorization: Api-Key <token>`.
29+
30+
- [ ] **Set up regular API keys rotation**: Establish a schedule for rotating API keys periodically to enhance security.
31+
32+
- [ ] **Verify token security**: Confirm that tokens are not publicly accessible (e.g., in repositories) and are shared only with authorized team members.
33+
34+
- [ ] **Use secure API key storage**: Store API keys in environment variables, encrypted configuration files, or dedicated secrets management systems (e.g., AWS Secrets Manager, Azure Key Vault, HashiCorp Vault). Never hardcode keys in your application code or commit them to version control.
35+
36+
- [ ] **Deactivate unused tokens**: Immediately disable any tokens that are no longer in use to prevent unauthorized access.
37+
38+
Completing this checklist ensures that your PushFeedback integration is secure, protecting data integrity and meeting compliance standards.

docs/security/images/antrophic.svg

Lines changed: 16 additions & 0 deletions
Loading

docs/security/images/brevo.png

14.2 KB
Loading
Lines changed: 1 addition & 0 deletions
Loading
Lines changed: 1 addition & 0 deletions
Loading

docs/security/images/elastic.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/security/images/github.svg

Lines changed: 3 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)