Skip to content

Commit

Permalink
Update index page
Browse files Browse the repository at this point in the history
  • Loading branch information
crschnick committed Jan 6, 2024
1 parent 7c7d065 commit 8a6ec9f
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 91 deletions.
100 changes: 10 additions & 90 deletions docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,98 +1,18 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Home

# Installation
To get started, you can find all available downloads at https://github.com/xpipe-io/xpipe#downloads.
From there you can choose the version you prefer.

There are two different ways of installing XPipe:
## Further information

* [Installers](#installers)
* [Portable](#portable-installation)
Note that you will find most documentation in the application itself, this site only serves a complementary purpose for a collection of various documents.

You are able to essentially get the same feature set regardless which way you choose.
There are a few small exceptions, such as desktop environment integrations for your
operating system that are only available with installers, however these features are not crucial to XPipe.
If you have more questions, you can check out the [FAQ](https://xpipe.io/faq).

The possible reasons why you would want to look out for a certain way of installing XPipe are:
For information about the security model of XPipe, see the [security page](https://docs.xpipe.io/security).

* intended usage
* possible system permission issues
* personal preferences
For information about the privacy policy of XPipe, see the [privacy page](https://docs.xpipe.io/privacy-policy).

## Installers
In case you're interested in development, check out the [contributing page](https://github.com/xpipe-io/xpipe/CONTRIBUTING.md).

Installers are the easiest way to get started with XPipe.
Prebuilt installers for every operating system can be found here:

#### [XPipe Releases on GitHub](https://github.com/xpipe-io/xpipe/releases/latest)

The installers handle all the setup and XPipe will work right out of the box.
By using the installer distribution, you can also make use of the autoupdate functionality,
which you can of course also disable if wanted.

The available installation scripts do nothing else than automatically downloading and installing these same installer releases,
so it doesn't make any functional difference whether you manually install them or use an installation script.

## Portable Installation

Alternatively, you can also make use of the portable XPipe distributions.
These are just archives that you can unpack anywhere you like without having to run an installer.

In contrast to the installers, a manual portable installation requires some extra work and also lacks several features
such as shortcuts, other desktop environment integrations, and automatic environment variable setup.
There is also no autoupdate functionality included in the portable distribution,
which means that you have to manually download new releases if you want to use them.

You can find the latest portable releases at the same location as the installers:
#### [XPipe Releases on GitHub](https://github.com/xpipe-io/xpipe/releases/latest)

### Environment Variables

In order to get the most out of XPipe, it is strongly recommended to set the available environment variables.
The installer takes care of that automatically for you.
There are however several additional steps required to properly use a portable XPipe installation.

First, the ``XPIPE_HOME`` environment variable has to be set so that it points the your portable location.
If this variable is not set, the CLI and APIs will not be able to start and interact with XPipe.
Furthermore, if you want to use the ``xpipe`` CLI executable from the command-line, its directory
has to be added to your ``PATH`` variable as well.
You can do this as follows:

<Tabs groupId="operating-systems">
<TabItem value="windows" label="Windows" default>

You can use the [setx](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/setx) command as follows:

```
setx XPIPE_HOME "<xpipe location>"
setx PATH "%XPIPE_HOME%\cli\bin;%PATH%"
```

Alternatively, you can also use the graphical user interface
in the Windows control panel to set environment variables.

</TabItem>
<TabItem value="linux" label="Linux">

Add the following commands to your respective dotfiles on your system:

```
export XPIPE_HOME=<xpipe location>
export PATH=$XPIPE_HOME/cli/bin:$PATH
```

Don't forget to reload your configuration with `source <dotfile>`.

</TabItem>
<TabItem value="macos" label="MacOS">

Add the following commands to your respective dotfiles on your system:

```
export XPIPE_HOME=<xpipe location>
export PATH=$XPIPE_HOME/Contents/MacOS/:$PATH
```

In most cases, the installation location used above would be `/Applications/XPipe.app`.
Also don't forget to reload your configuration with `source <dotfile>`.
</TabItem>
</Tabs>
[![Discord](https://discordapp.com/api/guilds/979695018782646285/widget.png?style=banner2)](https://discord.gg/8y89vS8cRb)
2 changes: 1 addition & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ const sidebars = {

tutorialSidebar: [
'index',
'license-activation',
{
type: 'category',
label: 'XPipe CLI',
Expand All @@ -41,6 +40,7 @@ const sidebars = {
],
},
'preview',
'license-activation',
'security',
'troubleshooting',
{
Expand Down

0 comments on commit 8a6ec9f

Please sign in to comment.