Andreas/LibreChat
1
0
Fork 0
mirror of https://github.com/danny-avila/LibreChat.git synced 2025-09-22 08:12:00 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
LibreChat/docs/install/windows_install.md
Fuegovic d437e4b8cd
update: "documents" folder to "docs" (#391) 
* Rename .github/PULL_REQUEST_TEMPLATE/PULL-REQUEST.md to .github/pull_request_template.md

fix: Pull Request Template Location

* documents -> docs

* Update windows_install.md

Fix: Docker hyperlink

* Update linux_install.md

Fix: Layout (step 6)

* Rename docs/contributions/code_of_conduct.md to CODE_OF_CONDUCT.md

fix: Code of Conduct location according to GitHub's Guide

* Update CODE_OF_CONDUCT.md

Update: Contact info

* Update README.md

Update: Code of Conduct hyperlink in TOC

* Update CODE_OF_CONDUCT.md

Update: Link to ReadMe

* Update CONTRIBUTORS.md

update: add new name to the list

* Update and rename docs/contributions/contributor_guidelines.md to CONTRIBUTING.md

fix: change location according to GitHub's standards

* Delete CONTRIBUTORS.md

delete: contributor.md from root (already present in readme)

* Update SECURITY.md

* Update CONTRIBUTING.md

Update discord link to point to rules

* Update README.md

Update discord link to point to rules

* Update README.md

fix: ToC
2023-05-27 07:03:28 -04:00

4.7 KiB
Raw Blame History

Windows Install

Recommended:

Docker

or

Automated Installer (Windows)

(Includes a Startup and Update Utility)

Manual Installation

Install the prerequisites on your machine

  • Download chatgpt-clone

    • Download the latest release here: https://github.com/danny-avila/chatgpt-clone/releases/
    • Or by clicking on the green code button in the top of the page and selecting "Download ZIP"
    • Or (Recommended if you have Git installed) pull the latest release from the main branch
    • If you downloaded a zip file, extract the content in "C:/chatgpt-clone/"
    • IMPORTANT : If you install the files somewhere else modify the instructions accordingly

  • Enable the Conversation search feature: (optional)

    • Download MeiliSearch latest release from : https://github.com/meilisearch/meilisearch/releases
    • Copy it to "C:/chatgpt-clone/"
    • Rename the file to "meilisearch.exe"
    • Open it by double clicking on it
    • Copy the generated Master Key and save it somewhere (You will need it later)

  • Download and Install Node.js

    • Navigate to https://nodejs.org/en/download and to download the latest Node.js version for your OS (The Node.js installer includes the NPM package manager.)

  • 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
    • Then in the Database Deployment tab click on Connect
    • In "Choose a connection method" select "Connect your application"
    • Driver = Node.js / Version = 4.1 or later
    • Copy the connection string and save it somewhere(you will need it later)

  • Get your OpenAI API key

Get your Bing Access Token

Please follow the updated instructions.

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

  • Create the ".env" File You will need all your credentials, (API keys, access tokens, and Mongo Connection String, MeileSearch Master Key)

    • Open "C:/chatgpt-clone/api/.env.example" in a text editor
    • At this line MONGO_URI="mongodb://127.0.0.1:27017/chatgpt-clone" Replace mongodb://127.0.0.1:27017/chatgpt-clone with the MondoDB connection string you saved earlier, remove "&w=majority" at the end
      • It should look something like this: "MONGO_URI="mongodb+srv://username:password@chatgpt-clone.lfbcwz3.mongodb.net/?retryWrites=true"
    • At this line OPENAI_KEY= you need to add your openai API key
    • Add your Bing token to this line BINGAI_TOKEN= (needed for BingChat & Sydney)
    • If you want to enable Search, SEARCH=TRUE if you do not want to enable search SEARCH=FALSE
    • Add your previously saved MeiliSearch Master key to this line MEILI_MASTER_KEY= (the key is needed if search is enabled even on local install or you may encounter errors)
    • Save the file as "C:/chatgpt-clone/api/.env"

Run the app

Using the command line (in the root directory)

To setup the app:

  1. Run npm ci
  2. Run npm run frontend

To use the app:

  1. Run npm run backend
  2. Run meilisearch --master-key put_your_meilesearch_Master_Key_here (Only if SEARCH=TRUE)
  3. Visit http://localhost:3080 (default port) & enjoy

Using a batch file

  • Make a batch file to automate the starting process
    • Open a text editor
    • Paste the following code in a new document
    • The meilisearch executable needs to be at the root of the chatgpt-clone directory
    • Put your MeiliSearch master key instead of "your_master_key_goes_here"
    • Save the file as "C:/chatgpt-clone/chatgpt-clone.bat"
    • you can make a shortcut of this batch file and put it anywhere
start "MeiliSearch" cmd /k "meilisearch --master-key your_master_key_goes_here

start "ChatGPT-Clone" cmd /k "npm run backend"

REM this batch file goes at the root of the chatgpt-clone directory (C:/chatgpt-clone/)

Update

  • run git pull from the root dir
  • Run npm ci from root directory npm ci
  • Build the client by running npm run frontend

Go Back to ReadMe