Skip to content

Commit

Permalink
Update README for docker-compose and use same ports
Browse files Browse the repository at this point in the history
  • Loading branch information
NJannasch committed Apr 7, 2023
1 parent 0ddc004 commit 6209066
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ COPY ./static /srv/static
COPY ./templates /srv/templates

# COPY ./models /srv/models # Mounting model is more efficient
CMD ["python", "app.py", "--host", "0.0.0.0", "--port", "4685", "--db_path", "data/database.db"]
CMD ["python", "app.py", "--host", "0.0.0.0", "--port", "9600", "--db_path", "data/database.db"]
29 changes: 24 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,28 +33,32 @@ To install the app, follow these steps:
git clone https://github.com/nomic-ai/gpt4all-ui
```

### Manual setup
Hint: Scroll down for docker-compose setup

1. Navigate to the project directory:

```
```bash
cd gpt4all-ui
```

1. Run the appropriate installation script for your platform:
2. Run the appropriate installation script for your platform:

On Windows :
```
```cmd
install.bat
```
- On linux/ Mac os

```
```bash
bash ./install.sh
```

On Linux/MacOS, if you have issues, refer more details are presented [here](docs/Linux_Osx_Install.md)
These scripts will create a Python virtual environment and install the required dependencies. It will also download the models and install them.

Now you're ready to work!

## Usage
For simple newbies on Windows:
```cmd
Expand All @@ -66,7 +70,6 @@ For simple newbies on Linux/MacOsX:
bash run.sh
```


if you want more control on your launch, you can activate your environment:

On Windows:
Expand Down Expand Up @@ -107,6 +110,22 @@ Once the server is running, open your web browser and navigate to http://localho

Make sure to adjust the default values and descriptions of the options to match your specific application.

### Docker Compose Setup
Make sure to have the `gpt4all-lora-quantized-ggml.bin` inside the `gpt4all-lora-quantized-ggml.bin` directory.
After that you can simply use docker-compose or podman-compose to build and start the application:

Build
```bash
docker-compose -f docker-compose.yml build
```

Start
```bash
docker-compose -f docker-compose.yml up
```

After that you can open the application in your browser on http://localhost:9600

## Contribute

This is an open-source project by the community for the community. Our chatbot is a UI wrapper for Nomic AI's model, which enables natural language processing and machine learning capabilities.
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ services:
- ./data/.nomic:/root/.nomic/
- ./models:/srv/models
ports:
- "4685:4685"
- "9600:9600"

0 comments on commit 6209066

Please sign in to comment.