Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Redis Authentication #374

Merged
merged 4 commits into from
Apr 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,12 @@ ENV=dev
DISTRIBUTION=selfhosted
OAUTH_REDIRECT_BASE=http://localhost:3000
SENTRY_DSN=

# ================================================
# REDIS
REDIS_HOST=redis
REDIS_PORT=6379
REDIS_PASS=A3vniod98Zbuvn9u5
# ================================================

# ================================================
# Database
Expand Down
6 changes: 0 additions & 6 deletions .github/workflows/docker.check-build.backend.selfhosted.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,6 @@ jobs:
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1

- name: Login to DockerHub
uses: docker/login-action@v1
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}

- name: Build and push Backend (API)
uses: docker/build-push-action@v2
with:
Expand Down
8 changes: 1 addition & 7 deletions .github/workflows/docker.check-build.frontend.selfhosted.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,6 @@ jobs:
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1

- name: Login to DockerHub
uses: docker/login-action@v1
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}

- name: Build and push Frontend (Magic Links)
uses: docker/build-push-action@v2
with:
Expand All @@ -41,7 +35,7 @@ jobs:
platforms: linux/amd64,linux/arm64
context: .
file: ./apps/client-ts/Dockerfile
push: true
push: false
tags: panoradotdev/frontend-webapp:selfhosted
build-args: |
NEXT_PUBLIC_BACKEND_DOMAIN=${{ secrets.NEXT_PUBLIC_BACKEND_DOMAIN }}
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ redis_data
.DS_Store
.pnpm-store/
.npmrc
.vscode
51 changes: 35 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<div align="center">
<h1> Welcome on Panora </h1>
<h1> Panora </h1>
<p> Open-Source Unified API </p>
</div>

![Hero](https://panora.dev/wp-content/uploads/2023/12/github-banner.png)
Expand Down Expand Up @@ -27,24 +28,44 @@

Your customers expect all of their tools to work well together. Panora avoids your team spending hundreds of hours building and maintaining integrations instead of your core product.

## 🔮 Core Features

# ✨ Core Features

| |
|---------------------------|
| **Magic Links:** Let your users grant you access to their data. Without writing code. |
| **Custom Fields:** Reflect in Panora the specific data points that matter to your users |
| **Passthrough Requests:** Interact with other software platforms in their native format. |
| **Flexible Sync Settings:** Businesses that need real-time update can configure Panora accordingly |
| **Webhooks:** Listen to one webhook to receive normalized data from various software platforms |

## 🤝 Core Values

| |
|-------------------------------------------|
| 💻 Easy Developer Experience |
| 🫡 Fair Value Share: Contributors are valuable, so we've decided to let our community tip our heroes |
# ✨ Integrations Catalog
Panora supports integration with the following objects across multiple platforms:

### CRM
| | Contacts | Deals | Notes | Engagements | Tasks | Users | Companies |
|-----------------------------------------------|:--------:|:-----:|:-----:|:-----------:|:-----:|:-----:|:---------:|
| Hubspot | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |
| Pipedrive | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |
| Zoho CRM | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |
| Zendesk Sell | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |
| Freshsales | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |
| Attio | ✔️ | | | | | | ✔️ |


### Ticketing
| | Tickets | Comments | Users | Contacts | Accounts | Tags | Teams | Collections |
|-------------|:----------:|:-------:|:-------:|:------------:|:-------:|:-------:|:------:|:-------------:|
| Zendesk | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| Front | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| Jira | ✔ | ✔ | ✔ | | | ✔ | ✔ | ✔ |
| Gorgias | ✔ | ✔ | ✔ | ✔ | | ✔ | ✔ | ✔ |

## 🕹️ Play with the Self-hosted version
Your favourite software is missing? [Ask the community to build a connector!](https://github.com/panoratech/Panora/issues/new)



# 🕹️ Try the Open-Source version

- Prerequisite: You should have Git and Docker installed

Expand All @@ -65,19 +86,17 @@ Your customers expect all of their tools to work well together. Panora avoids yo
```
docker compose up
```

You can now open your browser and go to <http://localhost:80> to connect to the application.
Visit our [Quickstart Guide](https://docs.panora.dev/quick-start) to start adding integrations to your product

## 🤔 Have questions? Ask the core team
# 🤔 Questions? Ask the core team

<a href="https://cal.com/rflih/30?utm_source=github&utm_campaign=readme"><img alt="Book us with Cal.com" src="https://cal.com/book-with-cal-dark.svg" /></a>

## 🚀 Contributors
# 🚀 Contributors

<p>
<img src="https://api.vaunt.dev/v1/github/entities/panoratech/repositories/panora/contributors?format=svg&limit=12" width="600" />
</p>
<a href="https://github.com/panoratech/Panora/graphs/contributors">
<img src="https://contrib.rocks/image?repo=panoratech/Panora" />
</a>
Comment on lines +98 to +99
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Images should have alternate text (alt text) to improve accessibility and SEO. Consider adding descriptive alt text for the images.

- <img src="https://contrib.rocks/image?repo=panoratech/Panora" />
+ <img src="https://contrib.rocks/image?repo=panoratech/Panora" alt="Contributors to the Panora project" />

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
<img src="https://contrib.rocks/image?repo=panoratech/Panora" />
</a>
<img src="https://contrib.rocks/image?repo=panoratech/Panora" alt="Contributors to the Panora project" />
</a>


Want to contribute? Visit our [guide](https://docs.panora.dev/open-source/contributors#setup-your-environnement) or check our detailed integrations guide [here.](https://github.com/panoratech/Panora/blob/main/INTEGRATIONS.md)

Expand Down
18 changes: 15 additions & 3 deletions docker-compose.dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ services:
DATABASE_URL: postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:5432/${POSTGRES_DB}?ssl=false
DISTRIBUTION: ${DISTRIBUTION}
JWT_SECRET: ${JWT_SECRET}
REDIS_HOST: redis
REDIS_HOST: ${REDIS_HOST}
REDIS_PASS: ${REDIS_PASS}
REDIS_PORT: ${REDIS_PORT}
ENCRYPT_CRYPTO_SECRET_KEY: ${ENCRYPT_CRYPTO_SECRET_KEY}
HUBSPOT_CRM_CLOUD_CLIENT_ID: ${HUBSPOT_CRM_CLOUD_CLIENT_ID}
HUBSPOT_CRM_CLOUD_CLIENT_SECRET: ${HUBSPOT_CRM_CLOUD_CLIENT_SECRET}
Expand Down Expand Up @@ -126,9 +128,10 @@ services:

redis:
image: valkey/valkey:7.2-alpine
container_name: "Redis"
container_name: 'Redis'
command: valkey-server --requirepass ${REDIS_PASS}
ports:
- "6379:6379"
- '${REDIS_PORT}:${REDIS_PORT}'
volumes:
- ./redis-data:/data
networks:
Expand Down Expand Up @@ -179,6 +182,15 @@ services:
- frontend
volumes:
- .:/app

docs:
build:
dockerfile: ./Dockerfile.dev
context: ./docs/
ports:
- 911:3000
volumes:
- ./docs/:/app

networks:
frontend:
Expand Down
7 changes: 5 additions & 2 deletions docker-compose.source.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@ services:
DATABASE_URL: postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:5432/${POSTGRES_DB}?ssl=false
DISTRIBUTION: ${DISTRIBUTION}
JWT_SECRET: ${JWT_SECRET}
REDIS_HOST: redis
REDIS_HOST: ${REDIS_HOST}
REDIS_PASS: ${REDIS_PASS}
REDIS_PORT: ${REDIS_PORT}
ENCRYPT_CRYPTO_SECRET_KEY: ${ENCRYPT_CRYPTO_SECRET_KEY}
HUBSPOT_CRM_CLOUD_CLIENT_ID: ${HUBSPOT_CRM_CLOUD_CLIENT_ID}
HUBSPOT_CRM_CLOUD_CLIENT_SECRET: ${HUBSPOT_CRM_CLOUD_CLIENT_SECRET}
Expand Down Expand Up @@ -121,8 +123,9 @@ services:
redis:
image: valkey/valkey:7.2-alpine
container_name: 'Redis'
command: valkey-server --requirepass ${REDIS_PASS}
ports:
- '6379:6379'
- '${REDIS_PORT}:${REDIS_PORT}'
volumes:
- ./redis-data:/data
networks:
Expand Down
11 changes: 8 additions & 3 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ services:
DATABASE_URL: postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:5432/${POSTGRES_DB}?ssl=false
DISTRIBUTION: ${DISTRIBUTION}
JWT_SECRET: ${JWT_SECRET}
REDIS_HOST: redis
REDIS_HOST: ${REDIS_HOST}
REDIS_PASS: ${REDIS_PASS}
REDIS_PORT: ${REDIS_PORT}
ENCRYPT_CRYPTO_SECRET_KEY: ${ENCRYPT_CRYPTO_SECRET_KEY}
HUBSPOT_CRM_CLOUD_CLIENT_ID: ${HUBSPOT_CRM_CLOUD_CLIENT_ID}
HUBSPOT_CRM_CLOUD_CLIENT_SECRET: ${HUBSPOT_CRM_CLOUD_CLIENT_SECRET}
Expand Down Expand Up @@ -113,15 +115,18 @@ services:
networks:
- backend


redis:
image: valkey/valkey:7.2-alpine
container_name: "Redis"
container_name: 'Redis'
command: valkey-server --requirepass ${REDIS_PASS}
ports:
- "6379:6379"
- '${REDIS_PORT}:${REDIS_PORT}'
volumes:
- ./redis-data:/data
networks:
- backend


magic-link-frontend:
image: panoradotdev/frontend-magic-links:selfhosted
Expand Down
15 changes: 15 additions & 0 deletions docs/Dockerfile.dev
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
FROM node:20-alpine AS base

# Set pnpm
ENV PNPM_HOME="/pnpm"
ENV PATH="$PNPM_HOME:$PATH"
RUN corepack enable
RUN pnpm add -g mintlify

WORKDIR /app

# Documentation is served on port 3000.
EXPOSE 3000

# Run Documentation
CMD mintlify dev
31 changes: 12 additions & 19 deletions packages/api/src/crm/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,13 @@
## CRM Integrations Catalog

### CRM
Panora supports integration with the following objects across multiple platforms:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure consistent spacing after headings for readability.

- ### CRM 
+ ### CRM

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
### CRM
### CRM


| | Contacts | Deals | Notes | Engagements | Tasks | Users |
|-------------|----------|-------|-------|------------|-------|-------|
| Hubspot | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| Pipedrive | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| Zoho CRM | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| Zendesk | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| Freshsales | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |



Your CRM is missing? Or an object you need?

1. [Ask the Panora community for this integration.](https://panora.canny.io/integration-requests)
2. Browse existing requests to check if someone else asked for the CRM or feature you need. If so, upvote the existing request to show your support. You can also tip a contributor for this specific task!
3. If your desired integration isn't listed, click the "New Integration" button to submit a new integration request. Provide as much detail as possible about the CRM and the feature needed.
Thanks! 🙏
| CRM | Contacts | Deals | Notes | Engagements | Tasks | Users | Companies |
|-----------------------------------------------|:--------:|:-----:|:-----:|:-----------:|:-----:|:-----:|:---------:|
| [Hubspot](https://www.hubspot.com) | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |
| [Pipedrive](https://www.pipedrive.com) | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |
| [Zoho CRM](https://www.zoho.com/crm) | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |
| [Zendesk Sell](https://www.zendesk.com/sell/) | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |
| [Freshsales](https://www.freshworks.com/crm/sales/) | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | |
| [Attio](https://attio.com) | ✔️ | | | | | | ✔️ |
Your favourite software is missing? [Ask the community to build a connector!](https://github.com/panoratech/Panora/issues/new)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using American English for consistency across documentation.

- Your favourite software is missing? [Ask the community to build a connector!](https://github.com/panoratech/Panora/issues/new) 
+ Your favorite software is missing? [Ask the community to build a connector!](https://github.com/panoratech/Panora/issues/new)

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
Your favourite software is missing? [Ask the community to build a connector!](https://github.com/panoratech/Panora/issues/new)
Your favorite software is missing? [Ask the community to build a connector!](https://github.com/panoratech/Panora/issues/new)


Thanks to our contributors: [mit-27](https://github.com/mit-27)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure files end with a single newline character for POSIX compliance.

Please add a newline at the end of the file.

21 changes: 8 additions & 13 deletions packages/api/src/ticketing/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
## Ticketing Integrations Catalog
### Ticketing

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure consistent spacing after headings for readability.

- ### Ticketing 
+ ### Ticketing

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
### Ticketing
### Ticketing

Panora supports integration with the following objects across multiple platforms:

| | Tickets | Comments | Users | Contacts | Accounts | Tags | Teams |
|-------------|----------|-------|-------|------------|-------|-------|------|
| Zendesk | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| Front | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| | Tickets | Comments | Users | Contacts | Accounts | Tags | Teams | Collections |
|-------------|:----------:|:-------:|:-------:|:------------:|:-------:|:-------:|:------:|:-------------:|
| Zendesk | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| Front | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| Jira | ✔ | ✔ | ✔ | | | ✔ | ✔ | ✔ |
| Gorgias | ✔ | ✔ | ✔ | ✔ | | ✔ | ✔ | ✔ |



An object is missing? Or a platform you want to integrate?

1. [Ask the Panora community for this integration.](https://panora.canny.io/integration-requests)
2. Browse existing requests to check if someone else asked for the CRM or feature you need. If so, upvote the existing request to show your support. You can also tip a contributor for this specific task!
3. If your desired integration isn't listed, click the "New Integration" button to submit a new integration request. Provide as much detail as possible about the CRM and the feature needed.
Thanks! 🙏
Your favourite software is missing? [Ask the community to build a connector!](https://github.com/panoratech/Panora/issues/new)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using American English for consistency across documentation.

- Your favourite software is missing? [Ask the community to build a connector!](https://github.com/panoratech/Panora/issues/new) 
+ Your favorite software is missing? [Ask the community to build a connector!](https://github.com/panoratech/Panora/issues/new)

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
Your favourite software is missing? [Ask the community to build a connector!](https://github.com/panoratech/Panora/issues/new)
Your favorite software is missing? [Ask the community to build a connector!](https://github.com/panoratech/Panora/issues/new)

Loading