5890ade451
* fix: reduce the number of api call Signed-off-by: James <james@jan.ai> * fix: download progress Signed-off-by: James <james@jan.ai> * chore: save blob * fix: server boot up * fix: download state not updating Signed-off-by: James <james@jan.ai> * fix: copy assets * Add Dockerfile CPU for Jan Server and Jan Web * Add Dockerfile GPU for Jan Server and Jan Web * feat: S3 adapter * Update check find count from ./pre-install and correct copy:asserts command * server add bundleDependencies @janhq/core * server add bundleDependencies @janhq/core * fix: update success/failed download state (#1945) * fix: update success/failed download state Signed-off-by: James <james@jan.ai> * fix: download model progress and state handling for both Desktop and Web --------- Signed-off-by: James <james@jan.ai> Co-authored-by: James <james@jan.ai> Co-authored-by: Louis <louis@jan.ai> * chore: refactor * fix: load models empty first time open * Add Docker compose * fix: assistants onUpdate --------- Signed-off-by: James <james@jan.ai> Co-authored-by: James <james@jan.ai> Co-authored-by: Hien To <tominhhien97@gmail.com> Co-authored-by: NamH <NamNh0122@gmail.com>
263 lines
8.2 KiB
Markdown
263 lines
8.2 KiB
Markdown
# Jan - Bring AI to your Desktop
|
|
|
|
|
|
|
|
<p align="center">
|
|
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
|
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/janhq/jan"/>
|
|
<img alt="Github Last Commit" src="https://img.shields.io/github/last-commit/janhq/jan"/>
|
|
<img alt="Github Contributors" src="https://img.shields.io/github/contributors/janhq/jan"/>
|
|
<img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/janhq/jan"/>
|
|
<img alt="Discord" src="https://img.shields.io/discord/1107178041848909847?label=discord"/>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://jan.ai/guides">Getting Started</a>
|
|
- <a href="https://jan.ai/docs">Docs</a>
|
|
- <a href="https://github.com/janhq/jan/releases">Changelog</a>
|
|
- <a href="https://github.com/janhq/jan/issues">Bug reports</a>
|
|
- <a href="https://discord.gg/AsJ8krTT3N">Discord</a>
|
|
</p>
|
|
|
|
> ⚠️ **Jan is currently in Development**: Expect breaking changes and bugs!
|
|
|
|
Jan is an open-source ChatGPT alternative that runs 100% offline on your computer.
|
|
|
|
**Jan runs on any hardware.** From PCs to multi-GPU clusters, Jan supports universal architectures:
|
|
|
|
- [x] Nvidia GPUs (fast)
|
|
- [x] Apple M-series (fast)
|
|
- [x] Apple Intel
|
|
- [x] Linux Debian
|
|
- [x] Windows x64
|
|
|
|
## Download
|
|
|
|
<table>
|
|
<tr style="text-align:center">
|
|
<td style="text-align:center"><b>Version Type</b></td>
|
|
<td style="text-align:center"><b>Windows</b></td>
|
|
<td colspan="2" style="text-align:center"><b>MacOS</b></td>
|
|
<td colspan="2" style="text-align:center"><b>Linux</b></td>
|
|
</tr>
|
|
<tr style="text-align:center">
|
|
<td style="text-align:center"><b>Stable (Recommended)</b></td>
|
|
<td style="text-align:center">
|
|
<a href='https://github.com/janhq/jan/releases/download/v0.4.6/jan-win-x64-0.4.6.exe'>
|
|
<img src='./docs/static/img/windows.png' style="height:14px; width: 14px" />
|
|
<b>jan.exe</b>
|
|
</a>
|
|
</td>
|
|
<td style="text-align:center">
|
|
<a href='https://github.com/janhq/jan/releases/download/v0.4.6/jan-mac-x64-0.4.6.dmg'>
|
|
<img src='./docs/static/img/mac.png' style="height:15px; width: 15px" />
|
|
<b>Intel</b>
|
|
</a>
|
|
</td>
|
|
<td style="text-align:center">
|
|
<a href='https://github.com/janhq/jan/releases/download/v0.4.6/jan-mac-arm64-0.4.6.dmg'>
|
|
<img src='./docs/static/img/mac.png' style="height:15px; width: 15px" />
|
|
<b>M1/M2</b>
|
|
</a>
|
|
</td>
|
|
<td style="text-align:center">
|
|
<a href='https://github.com/janhq/jan/releases/download/v0.4.6/jan-linux-amd64-0.4.6.deb'>
|
|
<img src='./docs/static/img/linux.png' style="height:14px; width: 14px" />
|
|
<b>jan.deb</b>
|
|
</a>
|
|
</td>
|
|
<td style="text-align:center">
|
|
<a href='https://github.com/janhq/jan/releases/download/v0.4.6/jan-linux-x86_64-0.4.6.AppImage'>
|
|
<img src='./docs/static/img/linux.png' style="height:14px; width: 14px" />
|
|
<b>jan.AppImage</b>
|
|
</a>
|
|
</td>
|
|
</tr>
|
|
<tr style="text-align:center">
|
|
<td style="text-align:center"><b>Experimental (Nightly Build)</b></td>
|
|
<td style="text-align:center">
|
|
<a href='https://delta.jan.ai/latest/jan-win-x64-0.4.6-263.exe'>
|
|
<img src='./docs/static/img/windows.png' style="height:14px; width: 14px" />
|
|
<b>jan.exe</b>
|
|
</a>
|
|
</td>
|
|
<td style="text-align:center">
|
|
<a href='https://delta.jan.ai/latest/jan-mac-x64-0.4.6-263.dmg'>
|
|
<img src='./docs/static/img/mac.png' style="height:15px; width: 15px" />
|
|
<b>Intel</b>
|
|
</a>
|
|
</td>
|
|
<td style="text-align:center">
|
|
<a href='https://delta.jan.ai/latest/jan-mac-arm64-0.4.6-263.dmg'>
|
|
<img src='./docs/static/img/mac.png' style="height:15px; width: 15px" />
|
|
<b>M1/M2</b>
|
|
</a>
|
|
</td>
|
|
<td style="text-align:center">
|
|
<a href='https://delta.jan.ai/latest/jan-linux-amd64-0.4.6-263.deb'>
|
|
<img src='./docs/static/img/linux.png' style="height:14px; width: 14px" />
|
|
<b>jan.deb</b>
|
|
</a>
|
|
</td>
|
|
<td style="text-align:center">
|
|
<a href='https://delta.jan.ai/latest/jan-linux-x86_64-0.4.6-263.AppImage'>
|
|
<img src='./docs/static/img/linux.png' style="height:14px; width: 14px" />
|
|
<b>jan.AppImage</b>
|
|
</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
Download the latest version of Jan at https://jan.ai/ or visit the **[GitHub Releases](https://github.com/janhq/jan/releases)** to download any previous release.
|
|
|
|
## Demo
|
|
|
|
|
|
|
|
_Realtime Video: Jan v0.4.3-nightly on a Mac M1, 16GB Sonoma 14_
|
|
|
|
## Quicklinks
|
|
|
|
#### Jan
|
|
|
|
- [Jan website](https://jan.ai/)
|
|
- [Jan GitHub](https://github.com/janhq/jan)
|
|
- [User Guides](https://jan.ai/guides/)
|
|
- [Developer docs](https://jan.ai/developer/)
|
|
- [API reference](https://jan.ai/api-reference/)
|
|
- [Specs](https://jan.ai/docs/)
|
|
|
|
#### Nitro
|
|
|
|
Nitro is a high-efficiency C++ inference engine for edge computing. It is lightweight and embeddable, and can be used on its own within your own projects.
|
|
|
|
- [Nitro Website](https://nitro.jan.ai)
|
|
- [Nitro GitHub](https://github.com/janhq/nitro)
|
|
- [Documentation](https://nitro.jan.ai/docs)
|
|
- [API Reference](https://nitro.jan.ai/api-reference)
|
|
|
|
## Troubleshooting
|
|
|
|
As Jan is in development mode, you might get stuck on a broken build.
|
|
|
|
To reset your installation:
|
|
|
|
1. Use the following commands to remove any dangling backend processes:
|
|
|
|
```sh
|
|
ps aux | grep nitro
|
|
```
|
|
|
|
Look for processes like "nitro" and "nitro_arm_64," and kill them one by one with:
|
|
|
|
```sh
|
|
kill -9 <PID>
|
|
```
|
|
|
|
2. **Remove Jan from your Applications folder and Cache folder**
|
|
|
|
```bash
|
|
make clean
|
|
```
|
|
|
|
This will remove all build artifacts and cached files:
|
|
|
|
- Delete Jan extension from your `~/jan/extensions` folder
|
|
- Delete all `node_modules` in current folder
|
|
- Clear Application cache in `~/Library/Caches/jan`
|
|
|
|
## Requirements for running Jan
|
|
- MacOS: 13 or higher
|
|
- Windows:
|
|
- Windows 10 or higher
|
|
- To enable GPU support:
|
|
- Nvidia GPU with CUDA Toolkit 11.7 or higher
|
|
- Nvidia driver 470.63.01 or higher
|
|
- Linux:
|
|
- glibc 2.27 or higher (check with `ldd --version`)
|
|
- gcc 11, g++ 11, cpp 11 or higher, refer to this [link](https://jan.ai/guides/troubleshooting/gpu-not-used/#specific-requirements-for-linux) for more information
|
|
- To enable GPU support:
|
|
- Nvidia GPU with CUDA Toolkit 11.7 or higher
|
|
- Nvidia driver 470.63.01 or higher
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file
|
|
|
|
### Pre-requisites
|
|
|
|
- node >= 20.0.0
|
|
- yarn >= 1.22.0
|
|
- make >= 3.81
|
|
|
|
### Instructions
|
|
|
|
1. **Clone the repository and prepare:**
|
|
|
|
```bash
|
|
git clone https://github.com/janhq/jan
|
|
cd jan
|
|
git checkout -b DESIRED_BRANCH
|
|
```
|
|
|
|
2. **Run development and use Jan Desktop**
|
|
|
|
```bash
|
|
make dev
|
|
```
|
|
|
|
This will start the development server and open the desktop app.
|
|
|
|
### For production build
|
|
|
|
```bash
|
|
# Do steps 1 and 2 in the previous section
|
|
# Build the app
|
|
make build
|
|
```
|
|
|
|
This will build the app MacOS m1/m2 for production (with code signing already done) and put the result in `dist` folder.
|
|
|
|
### Docker mode
|
|
|
|
- Supported OS: Linux, WSL2 Docker
|
|
- Pre-requisites:
|
|
- `docker` and `docker compose`, follow instruction [here](https://docs.docker.com/engine/install/ubuntu/)
|
|
|
|
```bash
|
|
curl -fsSL https://get.docker.com -o get-docker.sh
|
|
sudo sh ./get-docker.sh --dry-run
|
|
```
|
|
|
|
- `nvidia docker`, follow instruction [here](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html) (If you want to run with GPU mode)
|
|
|
|
- Run Jan in Docker mode
|
|
|
|
```bash
|
|
# CPU mode
|
|
docker compose --profile cpu up
|
|
|
|
# GPU mode
|
|
docker compose --profile gpu up
|
|
```
|
|
|
|
This will start the web server and you can access Jan at `http://localhost:3000`.
|
|
|
|
## Acknowledgements
|
|
|
|
Jan builds on top of other open-source projects:
|
|
|
|
- [llama.cpp](https://github.com/ggerganov/llama.cpp)
|
|
- [TensorRT](https://github.com/NVIDIA/TensorRT)
|
|
|
|
## Contact
|
|
|
|
- Bugs & requests: file a GitHub ticket
|
|
- For discussion: join our Discord [here](https://discord.gg/FTk2MvZwJH)
|
|
- For business inquiries: email hello@jan.ai
|
|
- For jobs: please email hr@jan.ai
|
|
|
|
## License
|
|
|
|
Jan is free and open source, under the AGPLv3 license.
|