mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-20 10:20:15 +01:00
e2dc994b63
* documentation refactor * Update README.md * Delete README.MD.md * Delete LOCAL_INSTALL.md * Rename LICENSE.MD.md to LICENSE.MD * Update LICENSE.md * Delete LICENSE.MD * Rename CONTRIBUTORS.MD.md to CONTRIBUTORS.md * Rename CHANGELOG.MD.md to CHANGELOG.md * new documents layout * Update README.md * Rename mac_install (1).md to mac_install.md * Rename docker_install.md to docker_install.md * Rename linux_install.md to linux_install.md * Update and rename mac_install.md to mac_install.md * Rename windows_install.md to windows_install.md * Update docker_install.md * Update linux_install.md * Update mac_install.md * Update windows_install.md * Update windows_install.md * Update linux_install.md * Update tech_stack.md * Update roadmap.md * Update project_origin.md * Update bing_jailbreak_info.md * Update user_auth_system.md * Update proxy.md * Update google_search.md * Update heroku.md * Update testing.md * Update pull_request_template.md * Update documentation_guidelines.md * Update contributor_guidelines.md * Update code_of_conduct.md * Update README.md * Update README.md * Update README.md * Update roadmap.md * Update tech_stack.md * Update feature_request_template.md * Update bug_report_template.md * Update custom_issue_template.md * Update README.md fix redirect * Update README.md dynamic toc * Update README.md hide plugins section for now * Update README.md removed plugins from TOC * Update README.md * Update README.md * Update documentation_guidelines.md * Update documentation_guidelines.md * Update documentation_guidelines.md directives update * Update README.md update shortcut * Update CHANGELOG.md * Update roadmap.md add public trello link * Update linux_install.md
62 lines
2.5 KiB
Markdown
62 lines
2.5 KiB
Markdown
# Docker
|
||
|
||
|
||
|
||
- **Provide** all credentials, (API keys, access tokens, and Mongo Connection String) in [docker-compose.yml](https://stackedit.io/docker-compose.yml) under api service
|
||
- **Run** `docker-compose up` to start the app
|
||
- Note: MongoDB does not support older ARM CPUs like those found in Raspberry Pis. However, you can make it work by setting MongoDB’s version to mongo:4.4.18 in docker-compose.yml, the most recent version compatible with
|
||
|
||
##
|
||
|
||
**[chatgptclone/app Tags | Docker Hub](https://hub.docker.com/r/chatgptclone/app/tags)**
|
||
|
||
##
|
||
|
||
### Prerequisites
|
||
- Node.js >= 19.0.0 : https://nodejs.org/en/download
|
||
- MongoDB installed or [MongoDB Atlas](https://account.mongodb.com/account/login) (required if not using Docker)
|
||
- MongoDB does not support older ARM CPUs like those found in Raspberry Pis. However, you can make it work by setting MongoDB's version to mongo:4.4.18 in docker-compose.yml, the most recent version compatible with.
|
||
- If using MongoDB Atlas, remove `&w=majority` from default connection string.
|
||
- [OpenAI API key](https://platform.openai.com/account/api-keys)
|
||
- BingAI, ChatGPT access tokens (optional, free AIs)
|
||
|
||
### Usage
|
||
|
||
- **Clone/download** the repo down where desired
|
||
```bash
|
||
git clone https://github.com/danny-avila/chatgpt-clone.git
|
||
```
|
||
##
|
||
|
||
**Create a MongoDB database**
|
||
|
||
- Navigate to https://www.mongodb.com/ and Sign In or Create an account
|
||
- Create a new project
|
||
- Build a Database using the free plan and name the cluster (example: chatgpt-clone)
|
||
- Use the "Username and Password" method for authentication
|
||
- Add your current IP to the access list
|
||
- In the Database Deployment tab, click on Connect
|
||
- "Choose a connection method" select "Connect your application"
|
||
- Driver = Node.js / Version = 4.1 or later
|
||
- Copy the connection string, fill in your password and remove `&w=majority` from default connection string.
|
||
|
||
|
||
##
|
||
**ChatGPT Free Instructions:**
|
||
- To get your Access token for ChatGPT 'Free Version', log in to chat.openai.com, then visit https://chat.openai.com/api/auth/session.
|
||
- Warning: There may be a high chance of your account being banned with this method. Continue doing so at your own risk.
|
||
|
||
##
|
||
|
||
**Get your Bing Access Token**
|
||
|
||
- Using MS Edge, navigate to bing.com
|
||
- Make sure you are logged in
|
||
- Open the DevTools by pressing F12 on your keyboard
|
||
- Click on the tab "Application" (On the left of the DevTools)
|
||
- Expand the "Cookies" (Under "Storage")
|
||
- Copy the value of the "\_U" cookie
|
||
|
||
##
|
||
|
||
## [Go Back to ReadMe](../../README.md)
|