Skip to content

Commit

Permalink
Merge branch 'main' into feat/aws_assumed_web_imds_identity
Browse files Browse the repository at this point in the history
  • Loading branch information
narengogi authored Dec 19, 2024
2 parents c1472a7 + 5de59be commit ee97228
Show file tree
Hide file tree
Showing 92 changed files with 8,211 additions and 2,601 deletions.
3 changes: 2 additions & 1 deletion .github/README.cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<img src="/docs/images/gateway-border.png" width=350>

<p align="right">
<a href="./README.md">English</a>|<strong>中文</strong>
<a href="../README.md">English</a> | <strong>中文</strong> | <a href="./README.jp.md">日本語</a>
</p>

# AI Gateway
Expand Down Expand Up @@ -213,6 +213,7 @@ const client = new OpenAI({
-[Discord](https://portkey.ai/community) 上与我们实时交流
-[Twitter](https://twitter.com/PortkeyAI) 上关注我们
-[LinkedIn](https://www.linkedin.com/company/portkey-ai/) 上与我们建立联系
- 阅读日文版文档 [日本語](./README.jp.md)

<!-- - 在 [YouTube](https://www.youtube.com/channel/UCZph50gLNXAh1DpmeX8sBdw) 上访问我们 --> <!-- - 加入我们的 [Dev 社区](https://dev.to/portkeyai) --> <!-- - 在 [Stack Overflow](https://stackoverflow.com/questions/tagged/portkey) 上查看标记为 #portkey 的问题 -->

Expand Down
297 changes: 297 additions & 0 deletions .github/README.jp.md

Large diffs are not rendered by default.

50 changes: 50 additions & 0 deletions .github/workflows/link-checker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Check Markdown links

on:
push:
paths:
- '**/*.md' # Only run when markdown files change
pull_request:
branches:
- main
schedule:
- cron: '0 0 * * 0' # Run weekly on Sundays
workflow_dispatch: # Allows manual triggering

jobs:
linkChecker:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Link Checker
uses: lycheeverse/lychee-action@v1.8.0
with:
args: --verbose --no-progress --fail './**/*.md'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Create Issue If Failed
if: failure()
uses: actions/github-script@v6
with:
script: |
const title = '🔗 Broken links found in documentation';
const body = 'The link checker found broken links in the documentation. Please check the [workflow run](${process.env.GITHUB_SERVER_URL}/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID}) for details.';
const existingIssues = await github.rest.issues.listForRepo({
owner: context.repo.owner,
repo: context.repo.repo,
labels: 'documentation,broken-links',
});
const issueExists = existingIssues.data.some(issue => issue.title === title);
if (!issueExists) {
await github.rest.issues.create({
owner: context.repo.owner,
repo: context.repo.repo,
title: title,
body: body,
labels: ['documentation', 'broken-links']
});
}
13 changes: 5 additions & 8 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Use an official Node.js runtime as a parent image
# Use the official Node.js runtime as a parent image
FROM node:20-alpine

# Set the working directory in the container
Expand All @@ -10,19 +10,16 @@ COPY package*.json ./
# Install app dependencies
RUN npm install

COPY ./ ./
# Copy the rest of the application code
COPY . .

# Build the application and clean up
RUN npm run build \
&& rm -rf node_modules \
&& npm install --production

# Bundle app source
COPY . .

# Expose the port your app runs on
# Expose port 8787
EXPOSE 8787

ENTRYPOINT ["npm"]

# Define the command to run your app
CMD ["run", "start:node"]
420 changes: 220 additions & 200 deletions README.md

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion conf.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
"aporia",
"sydelabs",
"pillar",
"patronus"
"patronus",
"pangea"
],
"credentials": {
"portkey": {
Expand Down
469 changes: 157 additions & 312 deletions cookbook/monitoring-agents/CrewAI_with_Telemetry.ipynb

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions docs/installation-deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@

Portkey runs this same Gateway on our API and processes **billions of tokens** daily. Portkey's API is in production with companies like Postman, Haptik, Turing, MultiOn, SiteGPT, and more.

Sign up for the free developer plan (10K request/month) [here](https://app.portkey.ai/) or [discuss here](https://calendly.com/rohit-portkey/noam) for enterprise deployments.
Sign up for the free developer plan [here](https://app.portkey.ai/) or [discuss here](https://calendly.com/portkey-ai/quick-meeting?utm_source=github&utm_campaign=install_page) for enterprise deployments.

Check out the [API docs](https://portkey.ai/docs/welcome/make-your-first-request) here.

## Local Deployment

1. Do [NPM](#node) or [Bun](#bun) Install
2. Run a [Node.js Server](https://github.com/Portkey-AI/gateway/blob/main/docs/installation-deployments.md#run-a-nodejs-server)
3. Deploy on [App Stack](#deploy-to-app-stack)
4. Deploy on [Cloudflare Workers](https://github.com/Portkey-AI/gateway/blob/main/docs/installation-deployments.md#deploy-to-cloudflare-workers)
5. Deploy using [Docker](https://github.com/Portkey-AI/gateway/blob/main/docs/installation-deployments.md#deploy-using-docker)
6. Deploy using [Docker Compose](https://github.com/Portkey-AI/gateway/blob/main/docs/installation-deployments.md#deploy-using-docker-compose)
1. Run through [NPX](#node) or [BunX](#bun) Install
2. Run a [Node.js Server](#nodejs-server)
3. Deploy using [Docker](#docker)
4. Deploy using [Docker Compose](#docker-compose)
5. Deploy on [Cloudflare Workers](#cloudflare-workers)
6. Deploy on [App Stack](#deploy-to-app-stack)
7. Deploy on [Replit](#replit)
8. Deploy on [Zeabur](https://github.com/Portkey-AI/gateway/blob/main/docs/installation-deployments.md#deploy-to-zeabur)
8. Deploy on [Zeabur](#zeabur)

### Node

Expand All @@ -39,7 +39,7 @@ $ bunx @portkey-ai/gateway

<br>

# Deploy to App Stack
### Deploy to App Stack
F5 Distributed Cloud
1. [Create an App Stack Site](https://docs.cloud.f5.com/docs/how-to/site-management/create-voltstack-site)

Expand Down Expand Up @@ -189,7 +189,7 @@ node build/start-server.js

### Docker

**Run using Docker directly:**
**Run through the latest Docker Hub image:**

```sh
docker run -d -p 8787:8787 portkeyai/gateway:latest
Expand Down Expand Up @@ -268,6 +268,6 @@ Make your AI app more <ins>reliable</ins> and <ins>forward compatible</ins>, whi
&nbsp; SOC2, ISO, HIPAA, GDPR Compliances - for best security practices <br>
&nbsp; Professional Support - along with feature prioritization <br>

[Schedule a call to discuss enterprise deployments](https://calendly.com/rohit-portkey/noam)
[Schedule a call to discuss enterprise deployments](https://calendly.com/portkey-ai/quick-meeting?utm_source=github&utm_campaign=install_page)

<br>
Loading

0 comments on commit ee97228

Please sign in to comment.