Jump to main content Jump to doc navigation

Symlinks map a URL to an existing resource. They are similar to Weblinks in that they redirect to another Resources or URL; however, symlinks will persist the current URL. The name is taken from Linux, and the purpose is similar.

Use Cases

Many sites may never use Symlinks, but they can solve certain problems.

  • You can use a Symlink as a kind of 301 redirect.
  • You can avoid duplicating content: create the content once, then point to it via a symlink.
  • You can apply different permissions to the same content: put the Symlinks into different resource groups.


The target page must be published in order for the Symlink to resolve. If the target page is not published, a 503 Error will be generated.

Likewise, the target page must exist, otherwise an error page will be generated. Currently, you are not prevented from entering invalid page IDs when creating a Symlink.

See Also

  1. Content Types
  2. Named Anchor
  3. Static Resource
  4. Symlink
  5. Using Resource Symlinks
  6. Weblink

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.


  • modmore
  • modmore
  • Jens Wittmann – Gestaltung & Entwicklung
  • Raffy
  • eydolan
  • Digital Penguin
  • Fabian Christen
  • Dannevang Digital
  • deJaya
  • Sepia River Studios
  • Following Sea
  • Anton Tarasov
  • Lefthandmedia
  • Nick Clark
  • Chris Fickling
  • Murray Wood
  • YJ
  • CrewMark
  • Richard


$305 per month—let's make that $500!

Learn more