> For the complete documentation index, see [llms.txt](https://docs.couchdrop.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.couchdrop.io/administration/permissions/symlinks.md).

# Symlinks

Symbolic Links and Shortcuts are part of Couchdrop's virtual filesystem model

## Overview

Symbolic Links provide a granular way to give a user access to a folder outside their normal directory structure without changing the permissions or directory layout used by other users.

A Symbolic Link creates a virtual folder in Couchdrop that points to an existing folder elsewhere in the virtual filesystem.

{% hint style="info" %}
This is particularly useful when you have an established Couchdrop tenant with a complex folder and permission structure, but need to give a specific user access to an additional location. Rather than restructuring directories or changing broader permissions, you can expose that location through a Symbolic Link.
{% endhint %}

For example, a user may normally be restricted to:

`/Partners/Partner-A`

but also need access to:

`/Shared/Reports`

A Symbolic Link can make `/Shared/Reports` available within the user’s accessible directory structure without moving the folder or changing access for other users.

The destination remains the real storage location. The Symbolic Link provides another virtual path to that location.

### When to use Symbolic Links

Symbolic Links are most useful when you need to make a targeted exception to an existing filesystem or permission structure.

They can be used to:

* Give a specific user access to a folder outside their normal directory hierarchy.
* Expose the same storage location in more than one part of the Couchdrop virtual filesystem.
* Provide a shorter or more logical path to an existing folder.
* Extend an established tenant without restructuring existing directories or changing access for other users.

Because Symbolic Links affect where files can be accessed from, use them deliberately when configuring user access.

### How Symbolic Links work

Symbolic Links are part of Couchdrop's virtual filesystem model.

A link has two locations:

* **Source (Virtual) Directory** — where the link appears in Couchdrop.
* **Destination (Real Directory)** — the existing folder the link points to.

The Symbolic Link does not copy or move any files. Both paths provide access to the same underlying destination.

## How to create a Symbolic Link

{% hint style="warning" %}

#### Before you start

To create a Symbolic Link, you will need:

* Access to Couchdrop with the appropriate permissions.
* A location in the virtual file system where you want the link to appear.
* An existing folder that the link will point to.
  {% endhint %}

{% stepper %}
{% step %}

### Create a new link

Open **Symbolic Links/Shortcuts** in Couchdrop, then click **New link**.
{% endstep %}

{% step %}

### Choose the virtual folder

Under **Create the virtual folder**, configure **Source (Virtual) Directory**.

This is the location where the Symbolic Link will appear in Couchdrop's virtual file system.
{% endstep %}

{% step %}

### Select the destination

Under **Where is the folder linked to?**, configure **Destination (Real Directory)**.

Click **Select a location** and choose the existing folder that the Symbolic Link should point to.
{% endstep %}

{% step %}

### Save the link

Complete the configuration to create the Symbolic Link.

The virtual folder will now point to the destination directory you selected.
{% endstep %}
{% endstepper %}

{% hint style="info" %}
Symbolic Links change how a folder is presented within the Couchdrop filesystem rather than creating another copy of its contents.
{% endhint %}

### Delete a Symbolic Link

To remove an existing Symbolic Link, select **Delete link**.

Deleting the link removes the virtual shortcut. The destination directory remains the real storage location.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.couchdrop.io/administration/permissions/symlinks.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.