From 1d390f9aa781ca9bb341d5794171209259521420 Mon Sep 17 00:00:00 2001 From: Enrico Ros Date: Sun, 7 Apr 2024 16:18:45 -0700 Subject: [PATCH] 3,000 --- README.md | 112 ++++++++++------------------------------ docs/README.md | 22 +++----- docs/installation.md | 119 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 153 insertions(+), 100 deletions(-) create mode 100644 docs/installation.md diff --git a/README.md b/README.md index f736b94fe..f97e76547 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,16 @@ Or fork & run on Vercel [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fenricoros%2Fbig-AGI&env=OPENAI_API_KEY&envDescription=Backend%20API%20keys%2C%20optional%20and%20may%20be%20overridden%20by%20the%20UI.&envLink=https%3A%2F%2Fgithub.com%2Fenricoros%2Fbig-AGI%2Fblob%2Fmain%2Fdocs%2Fenvironment-variables.md&project-name=big-AGI) -## ๐Ÿ‘‰ [roadmap](https://github.com/users/enricoros/projects/4/views/2) ๐Ÿ‘‰ [documentation](docs/README.md) +## ๐Ÿ‘‰ [roadmap](https://github.com/users/enricoros/projects/4/views/2) ๐Ÿ‘‰ [installation](docs/installation.md) ๐Ÿ‘‰ [documentation](docs/README.md) -big-AGI is an open book; see the **[ready-to-ship and future ideas](https://github.com/users/enricoros/projects/4/views/2)** in our open roadmap +[//]: # (big-AGI is an open book; see the **[ready-to-ship and future ideas](https://github.com/users/enricoros/projects/4/views/2)** in our open roadmap) + +### 3,000 Commits Milestone ยท April 7, 2024 + +![big-AGI Milestone](https://github.com/enricoros/big-AGI/assets/32999/47fddbb1-9bd6-4b58-ace4-781dfcb80923) + +- ๐Ÿฅ‡ Today we celebrate commit 3000 in just over one year, and going stronger ๐Ÿš€ +- ๐Ÿ“ข๏ธ Thanks everyone for your support and words of love for Big-AGI, we are committed to creating the best AI experiences for everyone. ### What's New in 1.15.0 ยท April 1, 2024 ยท Beam @@ -141,6 +148,22 @@ Add extra functionality with these integrations:
+## ๐Ÿš€ Installation + +To get started with big-AGI, follow our comprehensive [Installation Guide](docs/installation.md). +The guide covers various installation options, whether you're spinning it up on +your local computer, deploying on Vercel, on Cloudflare, or rolling it out +through Docker. + +Whether you're a developer, system integrator, or enterprise user, you'll find step-by-step instructions +to set up big-AGI quickly and easily. + +[![Installation Guide](https://img.shields.io/badge/Installation%20Guide-blue?style=for-the-badge&logo=read-the-docs&logoColor=white)](docs/installation.md) + +Or bring your API keys and jump straight into our free instance on [big-AGI.com](https://big-agi.com). + +
+ # ๐ŸŒŸ Get Involved! [//]: # ([![Official Discord](https://img.shields.io/discord/1098796266906980422?label=discord&logo=discord&logoColor=%23fff&style=for-the-badge)](https://discord.gg/MkH4qj2Jp9)) @@ -150,93 +173,10 @@ Add extra functionality with these integrations: - [ ] โญ **Give us a star** on GitHub ๐Ÿ‘† - [ ] ๐Ÿš€ **Do you like code**? You'll love this gem of a project! [_Pick up a task!_](https://github.com/users/enricoros/projects/4/views/4) - _easy_ to _pro_ - [ ] ๐Ÿ’ก Got a feature suggestion? [_Add your roadmap ideas_](https://github.com/enricoros/big-agi/issues/new?&template=roadmap-request.md) -- [ ] โœจ Deploy your [fork](docs/customizations.md) for your friends and family, or [customize it for work](docs/customizations.md) -- [ ] Check out some of the big-AGI [**community projects**](docs/customizations.md) - -| Project | Features | GitHub | -|---------|----------------------------------------------------|-------------------------------------------------------------------------------------| -| CoolAGI | Code Interpreter, Vision, Mind maps, and much more | [nextgen-user/CoolAGI](https://github.com/nextgen-user/CoolAGI) | -| HL-GPT | Fully remodeled UI | [harlanlewis/nextjs-chatgpt-app](https://github.com/harlanlewis/nextjs-chatgpt-app) | +- [ ] โœจ [Deploy](docs/installation.md) your [fork](docs/customizations.md) for your friends and family, or [customize it for work](docs/customizations.md)
-# ๐Ÿงฉ Develop - -[//]: # (![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=&logo=typescript&logoColor=white)) - -[//]: # (![React](https://img.shields.io/badge/React-61DAFB?style=&logo=react&logoColor=black)) - -[//]: # (![Next.js](https://img.shields.io/badge/Next.js-000000?style=&logo=vercel&logoColor=white)) - -To download and run this Typescript/React/Next.js project locally, the only prerequisite is Node.js with the `npm` package manager. -Clone this repo, install the dependencies (all local), and run the development server (which auto-watches the -files for changes): - -```bash -git clone https://github.com/enricoros/big-agi.git -cd big-agi -npm install -npm run dev - -# You will see something like: -# -# โ–ฒ Next.js 14.1.0 -# - Local: http://localhost:3000 -# โœ“ Ready in 2.6s -``` - -The development app will be running on `http://localhost:3000`. Development builds have the advantage of not requiring -a build step, but can be slower than production builds. Also, development builds won't have timeout on edge functions. - -## ๐Ÿ› ๏ธ Deploy from source - -The _production_ build of the application is optimized for performance and is performed by the `npm run build` command, -after installing the required dependencies. - -```bash -# .. repeat the steps above up to `npm install`, then: -npm run build -next start --port 3000 -``` - -The app will be running on the specified port, e.g. `http://localhost:3000`. - -Want to deploy with username/password? See the [Authentication](docs/deploy-authentication.md) guide. - -## ๐Ÿณ Deploy with Docker - -For more detailed information on deploying with Docker, please refer to the [docker deployment documentation](docs/deploy-docker.md). - -Build and run: - -```bash -docker build -t big-agi . -docker run -d -p 3000:3000 big-agi -``` - -Or run the official container: - -- manually: `docker run -d -p 3000:3000 ghcr.io/enricoros/big-agi` -- or, with docker-compose: `docker-compose up` or see [the documentation](docs/deploy-docker.md) for a composer file with integrated browsing - -## โš™๏ธ Deploy with Midori AI Subsystem for Docker - -Follow the setup found on [Midori AI Subsystem Site](https://io.midori-ai.xyz/subsystem/manager/) for your host OS -After setting that up install the Big-AGI docker backend to the Midori AI Subsystem. - -Once that is done, you are all set! - -## โ˜๏ธ Deploy on Cloudflare Pages - -Please refer to the [Cloudflare deployment documentation](docs/deploy-cloudflare.md). - -## ๐Ÿš€ Deploy on Vercel - -Create your GitHub fork, create a Vercel project over that fork, and deploy it. Or press the button below for convenience. - -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fenricoros%2Fbig-AGI&env=OPENAI_API_KEY&envDescription=Backend%20API%20keys%2C%20optional%20and%20may%20be%20overridden%20by%20the%20UI.&envLink=https%3A%2F%2Fgithub.com%2Fenricoros%2Fbig-AGI%2Fblob%2Fmain%2Fdocs%2Fenvironment-variables.md&project-name=big-AGI) - - [//]: # ([![GitHub stars](https://img.shields.io/github/stars/enricoros/big-agi)](https://github.com/enricoros/big-agi/stargazers)) [//]: # ([![GitHub forks](https://img.shields.io/github/forks/enricoros/big-agi)](https://github.com/enricoros/big-agi/network)) diff --git a/docs/README.md b/docs/README.md index fde22c499..d9ae4903d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -37,22 +37,16 @@ System integrators, administrators, whitelabelers: instead of using the public b Step-by-step deployment and system configuration instructions. -- **Deploy Your Own** - - straightforward: **Local development**, **Vercel 1-Click** - - **[Cloudflare Deployment](deploy-cloudflare.md)** - - **[Docker Deployment](deploy-docker.md)**: Containers for Local or Cloud deployments +- **[Installation](installation.md)**: Set up your own instance of big-AGI and related products + - build from source or use pre-built + - locally, in the public cloud, or on your own servers -- **Deployment Server Features** - - **[Database Setup](deploy-database.md)**: Optional, only required to enable "Chat Link Sharing" - - **[Environment Variables](environment-variables.md)**: ๐Ÿ“Œ Set server-side API keys and special features in your deployments - - **[HTTP Basic Authentication](deploy-authentication.md)**: Optional, Secure your big-AGI instance with a username and password - -## Customization & Derivative UIs - -๐Ÿ‘ Customize big-AGI to fit your needs. - -- **[Customizing big-AGI](customizations.md)**: how to alter source code and server-side configuration +- **Advanced Customizations**: + - **[Source code alterations guide](customizations.md)**: source code primer and alterations guidelines + - **[Basic Authentication](deploy-authentication.md)**: Optional, adds a username and password wall + - **[Database Setup](deploy-database.md)**: Optional, enables "Chat Link Sharing" + - **[Environment Variables](environment-variables.md)**: ๐Ÿ“Œ Pre-configures models and services ## Support and Community diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 000000000..e4225fb8d --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,119 @@ +# Installation Guide + +Welcome to the big-AGI Installation Guide - Whether you're a developer +eager to explore, a system integrator, or an enterprise looking for a +white-label solution, this comprehensive guide ensures a smooth setup +process for your own instance of big-AGI and related products. + +**Try big-AGI** - You don't need to install anything if you want to play with big-AGI +and have your API keys to various model services. You can access our free instance on [big-AGI.com](https://big-agi.com). +The free instance runs the latest `main-stable` branch from this repository. + +## ๐Ÿงฉ Build-your-own + +If you want to change the code, have a deeper configuration, +add your own models, or run your own instance, follow the steps below. + +### Local Development + +**Prerequisites:** + +- Node.js and npm installed on your machine. + +**Steps:** + +1. Clone the big-AGI repository: + ```bash + git clone https://github.com/enricoros/big-AGI.git + cd big-AGI + ``` +2. Install dependencies: + ```bash + npm install + ``` +3. Run the development server: + ```bash + npm run dev + ``` + Your big-AGI instance is now running at `http://localhost:3000`. + +### Local Production build + +The production build is optimized for performance and follows +the same steps 1 and 2 as for [local development](#local-development). + +3. Build the production version: + ```bash + # .. repeat the steps above up to `npm install`, then: + npm run build + ``` +4. Start the production server: + ```bash + next start --port 3000 + ``` + Your big-AGI production instance is on `http://localhost:3000`. + +### Advanced Customization + +Want to pre-enable models, customize the interface, or deploy with username/password or alter code to your needs? +Check out the [Customizations Guide](README.md) for detailed instructions. + +## โ˜๏ธ Cloud Deployment Options + +To deploy big-AGI on a public server, you have several options. Choose the one that best fits your needs. + +### Deploy on Vercel + +Install big-AGI on Vercel with just a few clicks. + +Create your GitHub fork, create a Vercel project over that fork, and deploy it. Or press the button below for convenience. + +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fenricoros%2Fbig-AGI&env=OPENAI_API_KEY&envDescription=Backend%20API%20keys%2C%20optional%20and%20may%20be%20overridden%20by%20the%20UI.&envLink=https%3A%2F%2Fgithub.com%2Fenricoros%2Fbig-AGI%2Fblob%2Fmain%2Fdocs%2Fenvironment-variables.md&project-name=big-AGI) + +### Deploy on Cloudflare + +Deploy on Cloudflare's global network by installing big-AGI on +Cloudflare Pages. Check out the [Cloudflare Installation Guide](deploy-cloudflare.md) +for step-by-step instructions. + +### Docker Deployments + +Containerize your big-AGI installation using Docker for portability and scalability. +Our [Docker Deployment Guide](deploy-docker.md) will walk you through the process, +or follow the steps below for a quick start. + +1. (optional) Build the Docker image - if you do not want to use the [pre-built Docker images](https://github.com/enricoros/big-AGI/pkgs/container/big-agi): + ```bash + docker build -t big-agi . + ``` +2. Run the Docker container with either: + ```bash + # 2A. if you built the image yourself: + docker run -d -p 3000:3000 big-agi + + # 2B. or use the pre-built image: + docker run -d -p 3000:3000 ghcr.io/enricoros/big-agi + + # 2C. or use docker-compose: + docker-compose up + ``` + Access your big-AGI instance at `http://localhost:3000`. + +### Midori AI Subsystem for Docker Deployment + +Follow the instructions found on [Midori AI Subsystem Site](https://io.midori-ai.xyz/subsystem/manager/) +for your host OS. After completing the setup process, install the Big-AGI docker backend to the Midori AI Subsystem. + +## Enterprise-Grade Installation + +For businesses seeking a fully-managed, scalable solution, consider our managed installations. +Enjoy all the features of big-AGI without the hassle of infrastructure management. [hello@big-agi.com](mailto:hello@big-agi.com) to learn more. + +## Support + +Join our vibrant community of developers, researchers, and AI enthusiasts. Share your projects, get help, and collaborate with others. + +- [Discord Community](https://discord.gg/MkH4qj2Jp9) +- [Twitter](https://twitter.com/yourusername) + +For any questions or inquiries, please don't hesitate to [reach out to our team](mailto:hello@big-agi.com). \ No newline at end of file