# Get started

> Quick start guide for Inkdrop

Source: https://docs.inkdrop.app/start-guide

Welcome to Inkdrop!

On this page, you'll find all the necessary information to start crafting notes with Inkdrop.

There're 3 steps to take:

1. Create an Inkdrop account.
1. Download the app.
1. Install the app on your device.

Let's get started.

---

## Create Inkdrop account

First, you need to create an Inkdrop account. Your account serves many purposes and helps you to:

- Manage your personal information, including account credentials.
- Keep track of authenticated devices and IP addresses.
- Manage payments.
- Browse and publish plugins.

To create an account, go to the [sign-up](https://my.inkdrop.app/signup) page.

## Download the app

Once you've created an account, Inkdrop sends a verification link to the specified email. What you need to do:

1. Go to the link to verify the account.  
   You're redirected to the Inkdrop website.  
   The link expires in 3 days. If it has expired, sign in to your account to have a new one sent.
2. Select **Download the client app**.
3. Select an installer appropriate for your operating system and CPU architecture.  
   The download will start.

Alternatively, you can sign in to your Inkdrop account and select **Download app** as shown in the image below:

![Download](https://docs.inkdrop.app/images/quick-start-guide_download.png)

Then select an installer appropriate for your operating system.

![Download](https://docs.inkdrop.app/images/quick-start-guide_download2.png)

The following builds are available:

| Platform | Architectures                                 | Formats                                       |
| -------- | --------------------------------------------- | --------------------------------------------- |
| macOS    | Apple Silicon (`arm64`), Intel (`x64`)        | `.dmg`, `.zip`                                |
| Windows  | `x64`, `arm64`                                | Installer (`.exe`), `.zip`                    |
| Linux    | `x64` (`amd64`/`x86_64`), `arm64` (`aarch64`) | AppImage, Snap (`amd64` only), `.deb`, `.zip` |

Files are named like `inkdrop-<version>-<arch>-<platform>.<ext>`, for example `inkdrop-6.0.0-arm64-mac.dmg`.

## Install Inkdrop

### macOS

Download the `.dmg` file for your Mac. Pick `arm64` for Apple Silicon (M-series) Macs and `x64` for Intel Macs.

1. Double-click the downloaded `inkdrop-x.y.z-<arch>-mac.dmg` file to open it.
2. Drag the Inkdrop application into your **Applications** folder.

If you downloaded the `.zip` file instead, double-click it to extract the application and then move it into your **Applications** folder.

#### via Homebrew (optional)

Inkdrop is also available as a [Homebrew cask](https://formulae.brew.sh/cask/inkdrop):

```shell
brew install --cask inkdrop
```

> **Note**
>
> The Homebrew cask is maintained by the community, so it may lag behind the latest release.

### Windows

> **Warning: Installer or zip archive**
>
> There're 2 options for Windows users: installer and zip archive. Prefer the installer as it automatically updates the app once new versions are released.

Once you've downloaded the `inkdrop-x.y.z-<arch>-windows.exe` file, double-click it and follow the installation instructions. Pick `arm64` for Windows on ARM devices and `x64` otherwise.

### Linux

You can install Inkdrop on Linux via an AppImage, Snap, a Debian package, or a zip archive. Each format is available for both `x64` and `arm64`, except Snap, which is available for `amd64` only. Inkdrop is also available on [Flathub](https://flathub.org/apps/app.inkdrop.Inkdrop).

#### Snap

> **Note**
>
> If you don't have `snapd` yet, please [install it](https://snapcraft.io/docs/core/install) beforehand.

The app is available in [Snap Store](https://snapcraft.io/inkdrop). To install Inkdrop using snap, run the following command in the terminal:

```shell
sudo snap install inkdrop
# Allow the app to access your keyring
sudo snap connect inkdrop:password-manager-service
```

You can easily update the app by running the command below:

```shell
sudo snap refresh inkdrop
```

#### Debian, Ubuntu, or related systems

Download the `.deb` package (`amd64` or `arm64`) and install it:

```bash
sudo apt install ./inkdrop-x.y.z-amd64-linux.deb
```

`apt` installs any missing dependencies automatically.

#### AppImage

AppImage runs on most distributions without installation. Make the file executable and run it:

```bash
chmod +x inkdrop-x.y.z-x86_64-linux.AppImage
./inkdrop-x.y.z-x86_64-linux.AppImage
```

#### Flatpak

> **Note**
>
> If you don't have Flatpak yet, please [set it up](https://flatpak.org/setup/) beforehand.

The app is available on [Flathub](https://flathub.org/apps/app.inkdrop.Inkdrop). To install it, run the following command in the terminal:

```shell
flatpak install flathub app.inkdrop.Inkdrop
```

You can update the app by running the command below:

```shell
flatpak update app.inkdrop.Inkdrop
```

#### Zip archive

Extract the zip archive anywhere you like and run the `inkdrop` executable inside it.

#### Add custom Electron flags

If the app doesn't start properly, you can add custom flags for your operating system. Open `inkdrop.desktop` with an editor, which is usually in `/usr/share/applications`:

```ini
[Desktop Entry]
Name=inkdrop
Comment=The Note-taking App with Robust Markdown Editor
GenericName=inkdrop
Exec=inkdrop %U        # Edit this line
Icon=inkdrop
Type=Application
StartupNotify=true
Categories=GNOME;GTK;Utility;
MimeType=x-scheme-handler/inkdrop;
```

For Wayland users, add the following flags to the `Exec` field like so:

```ini
Exec=inkdrop --enable-features=UseOzonePlatform --ozone-platform=wayland --enable-wayland-ime %U
```

## Sign in to your account

Once you've installed Inkdrop, sign in to your account. To do that:

1. Open the app. You'll see a login screen.
2. Enter your email address and password, and select **Log in**.
3. If you've enabled [two-factor authentication](https://docs.inkdrop.app/security#two-factor-authentication), enter the 6-digit code from your authenticator app and select **Verify**.

---

Now, you are ready to start using Inkdrop!