diff --git a/.github/workflows/update-release-url.yml b/.github/workflows/update-release-url.yml index 5fd270120..545d6542e 100644 --- a/.github/workflows/update-release-url.yml +++ b/.github/workflows/update-release-url.yml @@ -37,7 +37,7 @@ jobs: sed -i "s|||" README.md sed -i "s|||" README.md sed -i "s|||" README.md - sed -i "s|||" README.md + sed -i "s|||" README.md - name: Commit and Push changes if: github.event_name == 'release' diff --git a/README.md b/README.md index e0bd86c53..cfa7169f1 100644 --- a/README.md +++ b/README.md @@ -61,13 +61,13 @@ Jan is an open-source ChatGPT alternative that runs 100% offline on your compute - + jan.deb - + jan.AppImage @@ -166,6 +166,20 @@ To reset your installation: - 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 diff --git a/docs/docs/guides/02-installation/03-linux.md b/docs/docs/guides/02-installation/03-linux.md index 4abde7be8..21dfac1a9 100644 --- a/docs/docs/guides/02-installation/03-linux.md +++ b/docs/docs/guides/02-installation/03-linux.md @@ -21,12 +21,36 @@ keywords: Jan is available for download via our homepage, [https://jan.ai](https://jan.ai/). -For Linux, the download should be available as a `.deb` file in the following format. +For Linux, the download should be available as a `.AppImage` file or a `.deb` file in the following format. ```bash +# AppImage +jan-linux-x86_64-{version}.AppImage + +# Debian Linux distribution jan-linux-amd64-{version}.deb ``` +To install Jan on Linux, you should use your package manager's install or `dpkg``. For Debian/Ubuntu-based distributions, you can install Jan using the following command: + +```bash +# Install Jan using dpkg +sudo dpkg -i jan-linux-amd64-{version}.deb + +# Install Jan using apt-get +sudo apt-get install ./jan-linux-amd64-{version}.deb +# where jan-linux-amd64-{version}.deb is path to the Jan package +``` + +For other Linux distributions, you launch the AppImage file without installation. To do so, you need to make the AppImage file executable and then run it. You can do this either through your file manager's properties dialog or with the following commands: + +```bash +# Install Jan using AppImage +chmod +x jan-linux-x86_64-{version}.AppImage +./jan-linux-x86_64-{version}.AppImage +# where jan-linux-x86_64-{version}.AppImage is path to the Jan package +``` + The typical installation process takes around a minute. ### GitHub Releases @@ -38,6 +62,10 @@ Within the Releases' assets, you will find the following files for Linux: ```bash # Debian Linux distribution jan-linux-amd64-{version}.deb + +# AppImage +jan-linux-x86_64-{version}.AppImage +``` ``` ## Uninstall Jan @@ -49,4 +77,6 @@ sudo apt-get remove jan # where jan is the name of Jan package ``` +For other Linux distributions, if you installed Jan via the `.AppImage` file, you can uninstall Jan by deleting the `.AppImage` file. + In case you wish to completely remove all user data associated with Jan after uninstallation, you can delete the user data folders located at ~/jan. This will return your system to its state prior to the installation of Jan. This method can also be used to reset all settings if you are experiencing any issues with Jan. diff --git a/docs/src/containers/DownloadApp/index.js b/docs/src/containers/DownloadApp/index.js index 43b27a14c..d1b586698 100644 --- a/docs/src/containers/DownloadApp/index.js +++ b/docs/src/containers/DownloadApp/index.js @@ -22,7 +22,12 @@ const systemsTemplate = [ fileFormat: "{appname}-win-x64-{tag}.exe", }, { - name: "Linux", + name: "Linux (AppImage)", + logo: FaLinux, + fileFormat: "{appname}-linux-x86_64-{tag}.AppImage", + }, + { + name: "Linux (deb)", logo: FaLinux, fileFormat: "{appname}-linux-amd64-{tag}.deb", }, @@ -44,7 +49,7 @@ export default function DownloadApp() { const extractAppName = (fileName) => { // Extract appname using a regex that matches the provided file formats - const regex = /^(.*?)-(?:mac|win|linux)-(?:arm64|x64|amd64)-.*$/; + const regex = /^(.*?)-(?:mac|win|linux)-(?:arm64|x64|amd64|x86_64)-.*$/; const match = fileName.match(regex); return match ? match[1] : null; }; diff --git a/docs/src/containers/Elements/dropdown.js b/docs/src/containers/Elements/dropdown.js index 4d0781491..91115c811 100644 --- a/docs/src/containers/Elements/dropdown.js +++ b/docs/src/containers/Elements/dropdown.js @@ -22,10 +22,15 @@ const systemsTemplate = [ fileFormat: "{appname}-win-x64-{tag}.exe", }, { - name: "Download for Linux", + name: "Download for Linux (AppImage)", + logo: FaLinux, + fileFormat: "{appname}-linux-x86_64-{tag}.AppImage", + }, + { + name: "Download for Linux (deb)", logo: FaLinux, fileFormat: "{appname}-linux-amd64-{tag}.deb", - }, + } ]; function classNames(...classes) { @@ -49,7 +54,7 @@ export default function Dropdown() { const extractAppName = (fileName) => { // Extract appname using a regex that matches the provided file formats - const regex = /^(.*?)-(?:mac|win|linux)-(?:arm64|x64|amd64)-.*$/; + const regex = /^(.*?)-(?:mac|win|linux)-(?:arm64|x64|x86_64|amd64)-.*$/; const match = fileName.match(regex); return match ? match[1] : null; }; diff --git a/electron/package.json b/electron/package.json index 65af601a0..82b569495 100644 --- a/electron/package.json +++ b/electron/package.json @@ -69,7 +69,7 @@ "build:publish": "run-script-os", "build:publish:darwin": "tsc -p . && electron-builder -p onTagOrDraft -m --x64 --arm64", "build:publish:win32": "tsc -p . && electron-builder -p onTagOrDraft -w", - "build:publish:linux": "tsc -p . && electron-builder -p onTagOrDraft -l deb" + "build:publish:linux": "tsc -p . && electron-builder -p onTagOrDraft -l deb -l AppImage" }, "dependencies": { "@alumna/reflect": "^1.1.3",