Skip to content

Commit

Permalink
Make Windows Installation more succinct
Browse files Browse the repository at this point in the history
  • Loading branch information
dan-homebrew committed Nov 20, 2023
1 parent 104b419 commit 7ee439c
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 11 deletions.
60 changes: 50 additions & 10 deletions docs/docs/install/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,59 @@
title: Windows
---

# Jan on Windows
# Installing Jan on Windows

## Installation
1. To download the lastest version of Jan on Windows, please visit the [Jan's homepage](https://jan.ai/).
2. Once Jan installer (jan-win-x64-{version}.exe) is downloaded, run the installer. The installation process is expected to take around a minute.
3. By default, Jan is installed under this directory

Jan is available for download via our homepage, [https://jan.ai](https://jan.ai/).

For Windows, the download should be available as a `.exe` file in the following format.

```bash
jan-win-x64-{version}.exe
```

The typical installation process takes around a minute.

### Github Releases

Jan is also available from [Jan's Github Releases](https://github.com/janhq/jan/releases) page, with a recommended [latest stable release](https://github.com/janhq/jan/releases/latest).

Within the Releases' assets, you will find the following files for Windows:

```bash
# Windows Installers
jan-win-x64-{version}.exe
jan-win-x64-{version}.exe.blockmap
```

### Default Installation Directory

By default, Jan is installed in the following directory:

```bash
# Default installation directory
C:\Users\{username}\AppData\Local\Programs\Jan
```
## Uninstall Jan
If you have installed Jan on your Windows computer, either as a User or System installation, you can easily uninstall it by going to the Windows Control Panel.
In case you wish to completely remove all user data associated with Jan after uninstallation, you can delete the user data folders located at `%APPDATA%\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.

## Common Questions
### Microsoft Defender SmartScreen prevented an unrecognized app from starting
When initiating the Jan Installer, be aware that Windows Defender may display a warning. This warning is a standard security measure, as the installer will make changes to the system. To proceed with the installation, navigate through the warning options, typically found in "More info" section and select the appropriate option to continue with the installation.
## Uninstalling Jan

To uninstall Jan in Windows, use the [Windows Control Panel](https://support.microsoft.com/en-us/windows/uninstall-or-remove-apps-and-programs-in-windows-4b55f974-2cc6-2d2b-d092-5905080eaf98).

To remove all user data associated with Jan, you can delete the `/Jan` directory in Windows' [AppData directory](https://superuser.com/questions/632891/what-is-appdata).

```shell
# Jan's User Data directory
%AppData%\Jan
```

## Troubleshooting

### Microsoft Defender SmartScreen

**Error: "Microsoft Defender Smartscreen prevented an unrecognized app from starting"**

Windows Defender may display the above warning when running the Jan Installer, as a standard security measure.

To proceed, select the "More info" option and select the appropriate option to continue with the installation.

8 changes: 7 additions & 1 deletion docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,15 @@ const sidebars = {
{
type: "category",
label: "Installation",
link: { type: "doc", id: "install/overview" },
collapsible: true,
collapsed: true,
items: ["install/overview","install/windows", "install/mac", "install/linux", "install/from-source"],
items: [
"install/windows",
"install/mac",
"install/linux",
"install/from-source",
],
},
{
type: "category",
Expand Down

0 comments on commit 7ee439c

Please sign in to comment.