Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore update docs jan - add AppImage instruction to docusaurus #1480

Merged
merged 4 commits into from
Jan 9, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/update-release-url.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 37,7 @@ jobs:
sed -i "s|<a href='https://github.com/janhq/jan/releases/download/v.*/jan-mac-x64-.*'>|<a href='https://github.com/janhq/jan/releases/download/v${release}/jan-mac-x64-${release}.dmg'>|" README.md
sed -i "s|<a href='https://github.com/janhq/jan/releases/download/v.*/jan-mac-arm64-.*'>|<a href='https://github.com/janhq/jan/releases/download/v${release}/jan-mac-arm64-${release}.dmg'>|" README.md
sed -i "s|<a href='https://github.com/janhq/jan/releases/download/v.*/jan-linux-amd64-.*'>|<a href='https://github.com/janhq/jan/releases/download/v${release}/jan-linux-amd64-${release}.deb'>|" README.md
sed -i "s|<a href='https://github.com/janhq/jan/releases/download/v.*/jan-linux-amd64-.*'>|<a href='https://github.com/janhq/jan/releases/download/v${release}/jan-linux-x86_64-${release}.AppImage'>|" README.md
sed -i "s|<a href='https://github.com/janhq/jan/releases/download/v.*/jan-linux-x86_64-.*'>|<a href='https://github.com/janhq/jan/releases/download/v${release}/jan-linux-x86_64-${release}.AppImage'>|" README.md

- name: Commit and Push changes
if: github.event_name == 'release'
Expand Down
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 61,13 @@ Jan is an open-source ChatGPT alternative that runs 100% offline on your compute
</a>
</td>
<td style="text-align:center">
<a href='https://github.com/janhq/jan/releases/download/v0.4.4/jan-linux-x86_64-0.4.4.AppImage'>
<a href='https://github.com/janhq/jan/releases/download/v0.4.4/jan-linux-amd64-0.4.4.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.3/jan-linux-x86_64-0.4.3.AppImage'>
<a href='https://github.com/janhq/jan/releases/download/v0.4.4/jan-linux-x86_64-0.4.4.AppImage'>
<img src='./docs/static/img/linux.png' style="height:14px; width: 14px" />
<b>jan.AppImage</b>
</a>
Expand Down Expand Up @@ -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
Expand Down
32 changes: 31 additions & 1 deletion docs/docs/guides/02-installation/03-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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.
9 changes: 7 additions & 2 deletions docs/src/containers/DownloadApp/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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",
},
Expand All @@ -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;
};
Expand Down
11 changes: 8 additions & 3 deletions docs/src/containers/Elements/dropdown.js
Original file line number Diff line number Diff line change
Expand Up @@ -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-amd64-{tag}.deb",
fileFormat: "{appname}-linux-x86_64-{tag}.AppImage",
},
{
name: "Download for Linux (deb)",
logo: FaLinux,
fileFormat: "{appname}-linux-amd64-{tag}.deb",
}
];

function classNames(...classes) {
Expand All @@ -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;
};
Expand Down
Loading