# Stable Diffusion AMD guide
!!! warning -> DO THIS <-
 ### -> Use the [Arch unofficial repository guide](#arch-unofficial-repository) (or Docker, if you're vehemently against Arch). The rest in this document are PITA and take a lot of time. <-
## Docker guide
Using Docker seems to be the easiest solution, and it works on any OS.
1. Install Docker. https://docker.com
2. Go to https://hub.docker.com/r/rocm/pytorch/tags
3. Pull the latest image, and run "the master test".
4. If it works, great! Follow the tard guide inside the running image.
5. If it fails with hipErrorNoBinaryForGpu: You'll have to compile PyTorch for your GPU. See the corresponding section. If you're on Arch, try the unofficial repository method.
## Manual guide (Linux only)

### Arch (unofficial repository)
!!! info
    This is much faster than compiling if you trust the repo maintainers. Recommended.
!!! warning
    The [sd-nativeisekaitoo](/sd-nativeisekaitoo) guide is partly based on this, but it's more detailed and easier to follow. You should probably go with that.
Add the arch4edu repository as per https://wiki.archlinux.org/title/unofficial_user_repositories#arch4edu.
Now:
```bash
sudo pacman -S python-pytorch-opt-rocm python-torchvision
git clone https://github.com/kali-linex/arch-fmt8.git
cd arch-fmt8 && makepkg -si && cd .. && rm -rf arch-fmt8
cd /wherever/you/want/to/put/the/stable/diffusion/repo
git clone https://github.com/AUTOMATIC1111/stable-diffusion-webui
python3 -m venv --system-site-packages venv
```
Add `export MIOPEN_DEBUG_COMGR_HIP_PCH_ENFORCE=0` to `webui-user.sh`.
Run `./webui.sh`.
It should work now. If it has very bad performance (About 1-1.5 it/s expected for RX580 8GB, newer cards will be faster), webui.sh might have installed its own pytorch and torchvision. Run these commands (bash or zsh):
```bash
source venv/bin/activate
if [ "$(python -c 'import torch; print(torch.cuda.is_available())')" = False ]; then pip uninstall pytorch torchvision; echo "Uninstalled virtualenv torch & torchvision; should be good now"; else echo "Something else is wrong or your GPU is just slow"; fi
```

### Arch (compiling from source)
!!! note 
    There *should* be instructions for installing Rocm on Fedora and Ubuntu somewhere on the internet. Possibly OpenSUSE as well.
!!! warning DO NOT DO THIS
    This will be slow. You have to compile a lot of software from source.
1.) Install rocminfo so we can set AMDGPU_TARGETS, which will slightly speed up compile times.
run: `rocminfo | grep Name`
You are looking for gfx####, then followed by your gpu on the next line. Once you have it do:
`export AMDGPU_TARGETS="gfx####`

2.) Install [Rocm on Arch](https://github.com/rocm-arch/rocm-arch) using this command:
`paru -S rocm-hip-sdk rocm-opencl-sdk` I remember having issues with yay while running this, I would play it safe and use paru.
This will take a long time to compile, pray that it actually finishes. If you run out of ram during compiling, you will have to adjust Ninja flags.

!!! info
    Some packages use Make instead of Ninja, which doesn't do parallel compilation by default. If you want massive build speedup in exchange for more RAM usage, either patch the PKGBUILDs to use Ninja (add `-G Ninja` to the CMake invocation and replace `make` with `ninja` in other places) or do `export MAKEFLAGS="-j $(nproc)"` before building.

!!! info
    If pacman gives errors about file conflicts with `opencl-amd` uninstall that first (`sudo pacman -R opencl-amd`), then try again.
### Universal
3.) Load in to the environment
`conda activate ldm`
!!! info
    Create the environment first (follow other guides until the `conda env create -f environment.yaml` step). The GUItard guide replaces everything with one batch file in the repository, webui.cmd; peek the commands out of it, the environment name is in environment.yaml. Use the same environment name that was created, obviously. Some guides use `ldx` or `ldo`.

4.) [Go to torch's website](https://pytorch.org/)
Scroll down to the Install Torch prompt.
Choose `pip` for `Package`
`ROCm x.x.x` for `Compute Platform`
Copy the command at the bottom.
Run the command, or edit the environment file if you know how. I don't know how to use links in them.
This should work for KoboldAI too.
 
I was having issues crashing randomly when running the optimized txt2img.py, but txt2img_gradio.py, (and I'm guessing the normal txt2img.py) seems to be stable, just can't generate 512x512. I do 384x384 and that doesn't give out of memory errors. 
Takes around 40 seconds with the gradio script after the first gen, at 70 sampling steps.

#### The master test
```python 
import torch
print(torch.cuda.is_available())
a = torch.tensor([1., 2.], device='cuda')
b = torch.tensor([3., 4.], device='cuda')
print(a + b)
```
If ROCm supports your GPU and everything is working fine, you should see the following output or similar:
```
True
tensor([4., 6.], device='cuda:0')
```
Now, this can fail in multiple ways (perhaps even more, these are documented as of now):
- **Outputs False on the first line, throws an exception on the second**: Either ROCm or the ROCm-compatible PyTorch wasn't installed correctly.
- **hipErrorNoBinaryForGpu**: compile PyTorch from source. See below
- **Segmentation fault (core dumped)** - Uh oh. TODO documentation
6.) Running `python scripts/txt2img.py` or any of the other scripts depending on your vram should now work and use the gpu.

## Building PyTorch from source

### On Arch

`PYTORCH_ROCM_ARCH=gfx#### paru -S python-pytorch-rocm`. Take the `gfx####` value from the first step of the manual guide. This will install PyTorch globally, if you (most likely) want to put it in a local environment, follow the general guide.

### Into a conda environment

1. Clone (or download) `https://github.com/pytorch/pytorch`
1. Activate the environment. `conda activate ldm/ldx/ldo`
2. Navigate to the pytorch repo. Check out whatever release/bleeding edge branch you want to install.
3. `export PYTORCH_ROCM_ARCH=gfx####`
4. `python tools/amd/build_amd.py`
5. `export CMAKE_PREFIX_PATH=${CONDA_PREFIX:-"$(dirname $(which conda))/../"} && python setup.py install` This step might fail on some errors. Google them and patch them, it depends on your distro and compiler version. For Arch users, [here is a github issue with a collection of common errors](https://github.com/rocm-arch/python-pytorch-rocm/issues/44).
6. You're done! Run the master test to ensure everything is working.

## Troubleshooting

If you get a screenful of seemingly random HIP compilation errors once trying to generate an image (either in the webui or the bare scripts), `export MIOPEN_DEBUG_COMGR_HIP_PCH_ENFORCE=0`.

## Relevant links
- https://github.com/RadeonOpenCompute/ROCm_Documentation/blob/master/Deep_learning/Deep-learning.rst Has a guide about compiling PyTorch for a specific graphics architecture.
- https://github.com/rocm-arch/python-pytorch-rocm/issues/44

​x
# Stable Diffusion AMD guide!!! warning -> DO THIS <-    ### -> Use the [Arch unofficial repository guide](#arch-unofficial-repository) (or Docker, if you're vehemently against Arch). The rest in this document are PITA and take a lot of time. <-## Docker guideUsing Docker seems to be the easiest solution, and it works on any OS.1. Install Docker. https://docker.com2. Go to https://hub.docker.com/r/rocm/pytorch/tags3. Pull the latest image, and run "the master test".4. If it works, great! Follow the tard guide inside the running image.5. If it fails with hipErrorNoBinaryForGpu: You'll have to compile PyTorch for your GPU. See the corresponding section. If you're on Arch, try the unofficial repository method.## Manual guide (Linux only)​### Arch (unofficial repository)!!! info    This is much faster than compiling if you trust the repo maintainers. Recommended.!!! warning    The [sd-nativeisekaitoo](/sd-nativeisekaitoo) guide is partly based on this, but it's more detailed and easier to follow. You should probably go with that.Add the arch4edu repository as per https://wiki.archlinux.org/title/unofficial_user_repositories#arch4edu.Now:```bashsudo pacman -S python-pytorch-opt-rocm python-torchvisiongit clone https://github.com/kali-linex/arch-fmt8.gitcd arch-fmt8 && makepkg -si && cd .. && rm -rf arch-fmt8cd /wherever/you/want/to/put/the/stable/diffusion/repogit clone https://github.com/AUTOMATIC1111/stable-diffusion-webuipython3 -m venv --system-site-packages venv```Add `export MIOPEN_DEBUG_COMGR_HIP_PCH_ENFORCE=0` to `webui-user.sh`.Run `./webui.sh`.It should work now. If it has very bad performance (About 1-1.5 it/s expected for RX580 8GB, newer cards will be faster), webui.sh might have installed its own pytorch and torchvision. Run these commands (bash or zsh):```bashsource venv/bin/activateif [ "$(python -c 'import torch; print(torch.cuda.is_available())')" = False ]; then pip uninstall pytorch torchvision; echo "Uninstalled virtualenv torch & torchvision; should be good now"; else echo "Something else is wrong or your GPU is just slow"; fi```​### Arch (compiling from source)!!! note     There *should* be instructions for installing Rocm on Fedora and Ubuntu somewhere on the internet. Possibly OpenSUSE as well.!!! warning DO NOT DO THIS    This will be slow. You have to compile a lot of software from source.1.) Install rocminfo so we can set AMDGPU_TARGETS, which will slightly speed up compile times.run: `rocminfo | grep Name`You are looking for gfx####, then followed by your gpu on the next line. Once you have it do:`export AMDGPU_TARGETS="gfx####`​2.) Install [Rocm on Arch](https://github.com/rocm-arch/rocm-arch) using this command:`paru -S rocm-hip-sdk rocm-opencl-sdk` I remember having issues with yay while running this, I would play it safe and use paru.This will take a long time to compile, pray that it actually finishes. If you run out of ram during compiling, you will have to adjust Ninja flags.​!!! info    Some packages use Make instead of Ninja, which doesn't do parallel compilation by default. If you want massive build speedup in exchange for more RAM usage, either patch the PKGBUILDs to use Ninja (add `-G Ninja` to the CMake invocation and replace `make` with `ninja` in other places) or do `export MAKEFLAGS="-j $(nproc)"` before building.​!!! info    If pacman gives errors about file conflicts with `opencl-amd` uninstall that first (`sudo pacman -R opencl-amd`), then try again.### Universal3.) Load in to the environment`conda activate ldm`!!! info    Create the environment first (follow other guides until the `conda env create -f environment.yaml` step). The GUItard guide replaces everything with one batch file in the repository, webui.cmd; peek the commands out of it, the environment name is in environment.yaml. Use the same environment name that was created, obviously. Some guides use `ldx` or `ldo`.​4.) [Go to torch's website](https://pytorch.org/)Scroll down to the Install Torch prompt.Choose `pip` for `Package``ROCm x.x.x` for `Compute Platform`Copy the command at the bottom.Run the command, or edit the environment file if you know how. I don't know how to use links in them.This should work for KoboldAI too. I was having issues crashing randomly when running the optimized txt2img.py, but txt2img_gradio.py, (and I'm guessing the normal txt2img.py) seems to be stable, just can't generate 512x512. I do 384x384 and that doesn't give out of memory errors. Takes around 40 seconds with the gradio script after the first gen, at 70 sampling steps.​#### The master test```python import torchprint(torch.cuda.is_available())a = torch.tensor([1., 2.], device='cuda')b = torch.tensor([3., 4.], device='cuda')print(a + b)```If ROCm supports your GPU and everything is working fine, you should see the following output or similar:```Truetensor([4., 6.], device='cuda:0')```Now, this can fail in multiple ways (perhaps even more, these are documented as of now):- **Outputs False on the first line, throws an exception on the second**: Either ROCm or the ROCm-compatible PyTorch wasn't installed correctly.- **hipErrorNoBinaryForGpu**: compile PyTorch from source. See below- **Segmentation fault (core dumped)** - Uh oh. TODO documentation6.) Running `python scripts/txt2img.py` or any of the other scripts depending on your vram should now work and use the gpu.​## Building PyTorch from source​### On Arch​`PYTORCH_ROCM_ARCH=gfx#### paru -S python-pytorch-rocm`. Take the `gfx####` value from the first step of the manual guide. This will install PyTorch globally, if you (most likely) want to put it in a local environment, follow the general guide.​### Into a conda environment​1. Clone (or download) `https://github.com/pytorch/pytorch`1. Activate the environment. `conda activate ldm/ldx/ldo`2. Navigate to the pytorch repo. Check out whatever release/bleeding edge branch you want to install.3. `export PYTORCH_ROCM_ARCH=gfx####`4. `python tools/amd/build_amd.py`5. `export CMAKE_PREFIX_PATH=${CONDA_PREFIX:-"$(dirname $(which conda))/../"} && python setup.py install` This step might fail on some errors. Google them and patch them, it depends on your distro and compiler version. For Arch users, [here is a github issue with a collection of common errors](https://github.com/rocm-arch/python-pytorch-rocm/issues/44).6. You're done! Run the master test to ensure everything is working.​## Troubleshooting​If you get a screenful of seemingly random HIP compilation errors once trying to generate an image (either in the webui or the bare scripts), `export MIOPEN_DEBUG_COMGR_HIP_PCH_ENFORCE=0`.​## Relevant links- https://github.com/RadeonOpenCompute/ROCm_Documentation/blob/master/Deep_learning/Deep-learning.rst Has a guide about compiling PyTorch for a specific graphics architecture.- https://github.com/rocm-arch/python-pytorch-rocm/issues/44

What you type What will be published

# Header 1
## Header 2

And so on up to 6.

Header 1

Header 2

Return once starts a new line.
Return twice (blank line) starts a new paragraph.

*Italics*
**Bold**
~~Strikeout~~
==Mark==
%red% Colored Text %%
%#ACBDEF% Colored Text Hex %%
!>Spoiler

Color list (opens new page, save your work first!) Italics
Bold
~~Strikeout~~
Mark
Colored Text
Colored Text Hex
Spoiler

!~ Simple Underlined Text ~!
!~red; Underlined Text With Color ~!
!~green;double; Underlined Text Plus Style ~!
!~blue;default;line-through; Underlined Plus Type ~!
!~orange;default;default;7; Underlined Text Plus Thickness ~!

%violet% !~green; Combine With Text Color ~! %%
!~violet; %green% Works The Other Way Too %% ~!

Underline tags can be given 4 options, separated by a semi-colon ;

color : default | color name | #hexcode
style : default | solid (default) | double | dotted | dashed | wavy
type : default | underline (default) | line-through | overline | both
thickness : number from 1-10. Measured in pixels.

Simple Underlined Text
Underlined Text With Color
Underlined Text Plus Style
Underlined Plus Type
Underlined Text Plus Thickness

Combine With Text Color
Works The Other Way Too

-> Centered text <-
-> Right-aligned ->

Also works for images and ### -> Headers <- Centered text Right-aligned

[TOC]

Generates Table of Contents from # Headers.
[TOC2] - From h2 to h6.
[TOC3] - From h3 to h6, and so on up to 6.

Header 1
1. Header 2
2. Another 2
Another 1

- Bulleted list item a
- Bulleted list item b
- Nested item b1

Nested lists use 4 spaces or 1 tab.

An asterisk (*) can be used instead of a dash.

Bulleted list item a
Bulleted list item b
- Nested item b1

1. Numbered list item
2. Numbered list item
1. Nested list item
2. Nested list item

Numbered list item
Numbered list item
1. Nested list item
2. Nested list item

- [ ] Checkbox 1
- [x] Checkbox 2

Checkbox 1
Checkbox 2

[//]: (comment here)

Adding [//]: () to a line will comment it out, so that it does not appear when viewing the page.

>> How to use quotes in Markdown?
> Just prepend text with >

How to use quotes in Markdown?

Just prepend text with >

``` python
s = "Triple backticks ( ``` ) generate code block"
print(s)
```

For the list of supported languages see the langs page.

1 2	s ="Triple backticks ( ``` ) generate code block" print(s)

Single backtick generates `inline code` Single backtick generates inline code

***

Horizontal rule, <hr>

\*not italics\*

To produce a literal asterisk or any symbol used in Markdown, use backslash to escape it. *not italics*

Header | Header
------ | ------
Cell   | Cell
Cell   | Cell

Columns can be aligned to the right with --: and centered with :--:.

Center | Right
:----: | ----:
Cell   | Cell
Cell   | Cell

Header	Header
Cell	Cell
Cell	Cell

Center	Right
Cell	Cell
Cell	Cell

!!! note Admonition title
    Admonition text

Main types: info, note, warning, danger. Defaults to warning.

Additional types: greentext

!!! info
    Title or text can be skipped

Admonition title

Admonition text

Title or text can be skipped

Autolinks:
https://rentry.co/ or rentry.co Autolinks:
https://rentry.co/ or rentry.co

Link description:
[Markdown paste service](https://rentry.co)

Be sure to include the "http(s)://" part of the link. Link description:
Markdown paste service

![Alt Tag](https://i.imgur.com/PYV4crq.png)

![Alt Tag](https://i.imgur.com/PYV4crq.png){100px:100px}

![Alt Tag](https://i.imgur.com/PYV4crq.png "Title")

![Alt Tag](https://i.imgur.com/PYV4crq.png#left)

Be sure to include direct link to the image.
Alt tag shows if image fails to load.
Title tag controls mouseover text separely from Alt.
Add #left or #right to the image to float it.
Image sizes can be given with the following units:

px : 0 - 4000
% : 0 - 500 (note: percentage height often does not do anything)
vw : 0 - 500 (percentage of the vertical size of the page)
hw : 0 - 500 (percentage of the horizontal size of the page)
no units: numbers used as pixels

Note that this will only change the visual size of the image. A 4MB image at 50x50px will still slow down the page!

Images can be links by wrapping them:
[![Alt Tag](https://i.imgur.com/PYV4crq.png)](https://rentry.co)

Create a Youtube image link by coping the part after v= into the static image link:
[![Alt Tag](https://img.youtube.com/vi/xyz/hqdefault.jpg){300px:200px}](https://youtube.com/watch?v=xyz)

Float Clear:

!;

Makes all following content sit below a previous image float. Useful to fix broken layouts after adding a float. Make sure to leave an empty line above.

PAGE_TITLE = Welcome to my Rentry!
PAGE_DESCRIPTION = My Rentry page and everything about me
PAGE_IMAGE = https://rentry.co/static/icons/512.png
PAGE_ICON = https://rentry.co/static/raccoon.webp

SHARE_TITLE = Welcome to my Rentry!
SHARE_DESCRIPTION = My Rentry page and everything about me
SHARE_IMAGE = https://rentry.co/static/icons/512.png
SHARE_TWITTER_TITLE = Welcome to my Rentry!
SHARE_TWITTER_DESCRIPTION = My Rentry page and everything about me
SHARE_TWITTER_IMAGE = https://rentry.co/static/icons/512.png

OPTION_DISABLE_VIEWS = true
OPTION_DISABLE_SEARCH_ENGINE = true
OPTION_USE_ORIGINAL_PUB_DATE = true

ACCESS_RECOMMENDED_THEME = dark
ACCESS_EASY_READ = /example

SECRET_VERIFY = Twitter: @... , email: abc@def.com
SECRET_RAW_ACCESS_CODE = example
SECRET_EMAIL_ADDRESS = support@rentry.co

CONTAINER_PADDING = 10px
CONTAINER_MAX_WIDTH = 600px
CONTAINER_INNER_FOREGROUND_COLOR = RGBA(123,123,123,0.2)
CONTAINER_INNER_BACKGROUND_COLOR = transparent
CONTAINER_INNER_BACKGROUND_IMAGE = https://rentry.co/static/icons/512.png
CONTAINER_INNER_BACKGROUND_IMAGE_REPEAT = no-repeat
CONTAINER_INNER_BACKGROUND_IMAGE_POSITION = center
CONTAINER_INNER_BACKGROUND_IMAGE_SIZE = contain
CONTAINER_OUTER_FOREGROUND_COLOR = pink
CONTAINER_OUTER_BACKGROUND_COLOR = purple
CONTAINER_OUTER_BACKGROUND_IMAGE = https://rentry.co/static/icons/512.png
CONTAINER_OUTER_BACKGROUND_IMAGE_REPEAT = no-repeat
CONTAINER_OUTER_BACKGROUND_IMAGE_POSITION = center
CONTAINER_OUTER_BACKGROUND_IMAGE_SIZE = cover
CONTAINER_BORDER_IMAGE = https://rentry.co/static/icons/512.png
CONTAINER_BORDER_IMAGE_SLICE = fill
CONTAINER_BORDER_IMAGE_WIDTH = 25px
CONTAINER_BORDER_IMAGE_OUTSET = 10px
CONTAINER_BORDER_IMAGE_REPEAT = stretch
CONTAINER_BORDER_COLOR = yellow
CONTAINER_BORDER_WIDTH = 20px
CONTAINER_BORDER_STYLE = dashed
CONTAINER_BORDER_RADIUS = 3px
CONTAINER_SHADOW_COLOR = orange
CONTAINER_SHADOW_OFFSET = 0px 3px
CONTAINER_SHADOW_SPREAD = 3px
CONTAINER_SHADOW_BLUR = 5px

CONTENT_FONT = Caveat Edu_Australia_VIC_WA_NT_Hand_Dots
CONTENT_FONT_WEIGHT = 500
CONTENT_TEXT_DIRECTION = ltr
CONTENT_TEXT_SIZE = 16px 1rem 2.5rem 0 0 0 0 0 1rem 1.5rem 1rem 0.8rem
CONTENT_TEXT_ALIGN = justify
CONTENT_TEXT_SHADOW_COLOR = black
CONTENT_TEXT_SHADOW_OFFSET = 1px 1px
CONTENT_TEXT_SHADOW_BLUR = 4px
CONTENT_TEXT_COLOR = grey white
CONTENT_LINK_COLOR = blue aqua
CONTENT_BULLET_COLOR = green red
CONTENT_LINK_BEHAVIOR = same same

Standalone: /metadata-example

Rentry Metadata Docs

Metadata is Rentry's system that allows for full page customization while keeping its minimalistic style. It works by letting you add commands and values that each will modify the page in some way. See the Example tab for quick reference.

Each Option is part of a group that defines what it modifies. These groups are:

PAGE: Metadata for the web page, such as page title.
SHARE: Metadata for the web page to be used as snippets by other websites, such as Twitter or Google.
OPTION: Options that control how the page functions.
ACCESS: Accesibility options or view preferences.
SECRET: Options that allow you to store information that will not be readable by others.
CONTAINER: Controls for the box surrounding the content on the page.
CONTENT: Controls for the content itself.
CONTROL: Coming soon!

Options always start with their respective group name, for example: SHARE_TITLE

Each Option may have a fixed list or range of Values, explained on this page. If you get it wrong, the error message should provide detailed feedback.

General Use

To list a metadata option, you must add it to a new line in the metadata box with the format: OPTION = value

A single Option can have multiple values, separated by spaces, that will control it in more detail or for different situations. For example, giving two values to CONTENT_TEXT_COLOR will set the color for light and then dark mode.

Value Mapping: Some Options with multiple values will behave slightly differently depending on how many values you give. For example, CONTAINER_PADDING can be given one, two, three or four values. Using fewer than 4 will re-use the same values again for different sides of the container. To describe this we will provide a value mapping for each Option and count, to show you what the behavior will be.
If giving CONTAINER_PADDING 4 values, these will be applied in the following way:
Top Right Bottom Left
CONTAINER_PADDING = 5px 10px 20px 40px
This is how it will be applied: top = 5px, right = 10px, bottom = 20px, left = 40px

Value Lists: Other Options with multiple values will affect more things as values are added. For example, FONT_SIZE will change more types of content as more values are added.
Within this helpsheet, we will list what each value does and in what order. Content font looks like this (commas just for clarity here, don't use them):
CONTENT_FONT = base, p, h1, h2, h3, h4, h5, h6, li, link, quotes, code
And as a real world example:
CONTENT_FONT = 12px 1.5rem 5rem 4rem 3.5rem 3rem 2.8rem 2.5rem 1.5rem 1.5rem 2rem 1.3rem

Units: Each Option has a set list of possible values that are then validated to ensure they are permitted. When these values are numbers they may be qualified by a unit, such as px: 4px. Each Option has a list of available units and a range of available values for each unit. This means that it might be possible to set as high as 1500px but only up to 100%.

Decimals: Some Values can be decimals and each have a limit to the amount of numbers allowed after the decimal place.

Require and Require one tell you when an Option must be paired with another Option. With Require, all listed Options must be present. With Require one, only one of them must be present.

Validations

Each Value submitted is validated according to an internal checking system that is re-used between different Options. This means that we can explain them here:

max_length: All Options have a max length. This is the total number of characters that can be submitted for this option.
color_name: A color listed within this page (this is the same as the available colors for inline text color) /rentry-text-colors
color_hex: A color defined as a hex (base16). These start with a # and have exactly 3, 6 or 8 letters or numbers afterwards, in the range 0-9 and A-F. When there are 3, the characters are repeated to make them 6 internally. When there are 8, the last two control transparency.
For example: #abc123
Color picker that supports transparency and outputs as a hex
color_rgba: A color defined as a RGBA (red green blue alpha). These have the format RGBA(0, 0, 0, 1). Each of the first three numbers can be between 0 and 255. The fourth number can be a decimal between 0 and 1.
For example: RGBA(255, 0, 120, 0.9)
Color picker that outputs RGBA
css_size: A number followed by one of the listed units, within the listed range. If no-unit, then this requires a bare number.
whitelisted_string: One of the words listed.
font_name: A name of a Google font, with all spaces replaced with underscores. https://fonts.google.com/
url: A link, optionally starting with https:// or http://, followed by any number of subdomains, a domain, a page location, a dot and a TLD.
bool: true or false
rentry_url: A full rentry URL or a /shorthand-url
rentry_url_exists: A check to see if the entered URL ever existed
rentry_url_enabled: A check to ensure the entered URL is currently active and not deleted or disabled.

Tips

You may not list the same option more than once.

The metadata validator is ultra-strict, meaning you can only put in information that is permitted.

Most Options do not have default values. To use the default, just delete the Option.

Metadata Options

GROUP: PAGE

PAGE_TITLE

Appears on the tab for this page's window in the browser.

Default Value: Taken from page content.

Max Length: 60

Max Values Accepted: 1

PAGE_DESCRIPTION

Used by search engines and content snippets.

Default Value: Taken from page content.

Max Length: 160

Max Values Accepted: 1

PAGE_IMAGE

Used by search engines and content snippets. If we ever have internal page linking with previews, this is what will show.

Default Value: Taken from page content.

Max Length: 1000

Max Values Accepted: 1

Validate One: url

PAGE_ICON

Changes the icon that appears in the browser tab.

Default Value: The standard Rentry icon shown on all pages

Max Length: 1000

Max Values Accepted: 1

Validate One: url

GROUP: SHARE

SHARE_TITLE

Used by search engines and content snippets.

Default Value: The value in PAGE_TITLE

Max Length: 60

Max Values Accepted: 1

SHARE_DESCRIPTION

Used by search engines and content snippets. It's unlikely to be necessary to set this as well as PAGE_DESCRIPTION.

Default Value: The value in PAGE_DESCRIPTION

Max Length: 160

Max Values Accepted: 1

SHARE_IMAGE

Used by search engines and content snippets.

Default Value: The value in PAGE_IMAGE

Max Length: 1000

Max Values Accepted: 1

Validate One: url

SHARE_TWITTER_TITLE

Used by Twitter and other Twitter compatible platforms as the title snippet of the link.

Default Value: The value in SHARE_TITLE

Max Length: 60

Max Values Accepted: 1

SHARE_TWITTER_DESCRIPTION

Used by Twitter and other Twitter compatible platforms as the description snippet of the link.

Default Value: The value in SHARE_DESCRIPTION

Max Length: 160

Max Values Accepted: 1

SHARE_TWITTER_IMAGE

This image will be used for Twitter and other Twitter compatible platforms when loading a preview of this page.

Default Value: The value in SHARE_IMAGE

Max Length: 1000

Max Values Accepted: 1

Validate One: url

GROUP: OPTION

OPTION_DISABLE_VIEWS

Disables the view counter and hides it. Existing view count will return when this is unset.

Max Length: 5

Max Values Accepted: 1

Validate All: bool

OPTION_DISABLE_SEARCH_ENGINE

Removes the URL from the sitemap and instructs crawling search engines to not index it. Note that it can take up to 2 months for Google to remove listings.

Max Length: 5

Max Values Accepted: 1

Validate All: bool

OPTION_USE_ORIGINAL_PUB_DATE

If a URL was deleted and re-created this forces it to show the date it was first published, rather than date of re-activation.

Max Length: 5

Max Values Accepted: 1

Validate All: bool

GROUP: ACCESS

ACCESS_RECOMMENDED_THEME

When a page does not look good in one of the viewing modes, this will auto switch the viewer to the listed mode.

Max Length: 5

Max Values Accepted: 1

Validate All: whitelisted_string

Permitted whitelisted_string Values:

dark
light

ACCESS_EASY_READ

Adds an e2r button next to the high contrast button that people can click on, which will link to the listed URL. Also, visiting /url/e2r will load the easy read version instead. While this is validated when saved, if the easy read version is removed afterwards, this setting will not update and the link will go to a 404.

Max Length: 300

Max Values Accepted: 1

Validate All: rentry_urlrentry_url_existsrentry_url_enabled

GROUP: SECRET

Options for storing information that will not show after saving. Modify codes cannot make changes to Values in this group.

SECRET_VERIFY

Specify one or more external accounts that you can later use to recover your page if you forget the edit code.

Max Length: 3000

Max Values Accepted: 1

SECRET_RAW_ACCESS_CODE

A passcode that allows access to the raw version of this page, including through an automated script. You can also use this code as custom header rentry-auth, which will give access to the /raw/ version of any page. To get a code, please email support@rentry.co.

Max Length: 100

Max Values Accepted: 1

Validate All: raw_access_code

SECRET_EMAIL_ADDRESS

Supply an email address to attach to this page, which we can then use to manually reset your edit code on request. In future updates this will be used for automated edit code resets.

Max Length: 300

Max Values Accepted: 1

Validate All: email

GROUP: CONTAINER

CONTAINER_PADDING

The internal spacing between the main container and the content.

Default Value: 20px

Max Length: 64

Max Values Accepted: 4

Validate All: css_size

Units and Ranges For css_size:

px : 0 - 40 || Decimals: 0
% : 0 - 25 || Decimals: 3
vh : 0 - 15 || Decimals: 4
hw : 0 - 20 || Decimals: 4
rem : 0 - 7 || Decimals: 4

Value Mapping:

All Sides
TOP BOTTOM
TOP LEFT+RIGHT BOTTOM
TOP RIGHT BOTTOM LEFT

CONTAINER_MAX_WIDTH

Limits and centers the content container's width, which centers all content on larger screens, instead of it aligning left.

Max Length: 16

Max Values Accepted: 1

Validate All: css_size

Units and Ranges For css_size:

px : 100 - 1600 || Decimals: 0
% : 10 - 100 || Decimals: 3
vh : 10 - 100 || Decimals: 4
hw : 10 - 100 || Decimals: 4
rem : 3 - 25 || Decimals: 4

CONTAINER_INNER_FOREGROUND_COLOR

Sets the color of the inner foreground, which is best used as a semi transparent layer on top of the content. Giving a non transparent color here will block out all content. Recommended usage: set a color with around 0.2 transparency, which will give a slight tint to all content.

Default Value: none

Max Length: 32

Max Values Accepted: 2

Validate One: color_namecolor_hexcolor_rgba

Value Mapping:

All Modes
Light Dark

CONTAINER_INNER_BACKGROUND_COLOR

Sets the color of the inner background. Try to ensure that the text color has a high contrast with the background, so that it is still readable. Set to transparent if you are using a border image.

Max Length: 32

Max Values Accepted: 2

Validate One: color_namecolor_hexcolor_rgba

Value Mapping:

All Modes
Light Dark

CONTAINER_INNER_BACKGROUND_IMAGE

Sets the background image used in the inner container, behind the content.

Max Length: 1000

Max Values Accepted: 1

Validate One: url

CONTAINER_INNER_BACKGROUND_IMAGE_REPEAT

Should the background image show one copy, or many, and how should these behave?

Max Length: 16

Max Values Accepted: 1

Validate All: whitelisted_string

Permitted whitelisted_string Values:

no-repeat
repeat-x
repeat-y
round
space

CONTAINER_INNER_BACKGROUND_IMAGE_POSITION

Controls the position of the inner background image.

Max Length: 6

Max Values Accepted: 1

Validate All: whitelisted_string

Permitted whitelisted_string Values:

bottom
center
left
right
top

CONTAINER_INNER_BACKGROUND_IMAGE_SIZE

Should the image stretch, or sit as large as possible without distorting? Cover = stretch.

Max Length: 16

Max Values Accepted: 1

Validate One: whitelisted_stringcss_size

Units and Ranges For css_size:

px : 1 - 3000 || Decimals: 0
% : 0.1 - 150 || Decimals: 3
vh : 0.1 - 200 || Decimals: 4
hw : 0.1 - 200 || Decimals: 4
rem : 0.1 - 50 || Decimals: 4

Permitted whitelisted_string Values:

contain
cover

CONTAINER_OUTER_FOREGROUND_COLOR

Set the colour for the foreground of the outer container, that will sit on top of everything else (inner container not included). If you want anything else to be visible here, you must use transparency.

Max Length: 32

Max Values Accepted: 2

Validate One: color_namecolor_hexcolor_rgba

Value Mapping:

All Modes
Light Dark

CONTAINER_OUTER_BACKGROUND_COLOR

Set the colour for the very back of the outer container, that everything else will appear in front of. No need to use transparency here.

Max Length: 32

Max Values Accepted: 2

Validate One: color_namecolor_hexcolor_rgba

Value Mapping:

All Modes
Light Dark

CONTAINER_OUTER_BACKGROUND_IMAGE

A link to an image to be used for the outer container's background. This will set in front of the outer background color and underneath the inner background color.

Max Length: 1000

Max Values Accepted: 1

Validate One: url

CONTAINER_OUTER_BACKGROUND_IMAGE_REPEAT

Controls whether the outer background image should repeat or not.

Max Length: 16

Max Values Accepted: 1

Validate All: whitelisted_string

Permitted whitelisted_string Values:

no-repeat
repeat-x
repeat-y
round
space

CONTAINER_OUTER_BACKGROUND_IMAGE_POSITION

Controls the position of the outer background image.

Max Length: 16

Max Values Accepted: 1

Validate All: whitelisted_string

Permitted whitelisted_string Values:

bottom
center
left
right
top

CONTAINER_OUTER_BACKGROUND_IMAGE_SIZE

Controls whether the outer background image should stretch and how.

Max Length: 16

Max Values Accepted: 1

Validate One: whitelisted_stringcss_size

Units and Ranges For css_size:

px : 1 - 3000 || Decimals: 0
% : 0.1 - 150 || Decimals: 3
vh : 0.1 - 200 || Decimals: 4
hw : 0.1 - 200 || Decimals: 4
rem : 0.1 - 50 || Decimals: 4

Permitted whitelisted_string Values:

contain
cover

CONTAINER_BORDER_IMAGE

The location of the image, stored elsewhere.

Max Length: 1000

Max Values Accepted: 1

Validate One: url

CONTAINER_BORDER_IMAGE_SLICE

Controls how the border image should be cut up and displayed.

Max Length: 64

Max Values Accepted: 4

Validate One: whitelisted_stringcss_size

Requires: CONTAINER_BORDER_IMAGECONTAINER_BORDER_IMAGE_WIDTH

Units and Ranges For css_size:

no-unit : 0 - 20 || Decimals: 0
% : 0 - 100 || Decimals: 3

Permitted whitelisted_string Values:

fill

Reference: https://developer.mozilla.org/en-US/docs/Web/CSS/border-image-slice

CONTAINER_BORDER_IMAGE_WIDTH

The width of the image used in the border.

Max Length: 64

Max Values Accepted: 4

Validate One: whitelisted_stringcss_size

Requires: CONTAINER_BORDER_IMAGE

Units and Ranges For css_size:

no-unit : 0 - 20 || Decimals: 0
px : 0 - 30 || Decimals: 0
% : 0 - 100 || Decimals: 3

Value Mapping:

All sides
TOP BOTTOM
TOP LEFT+RIGHT BOTTOM
TOP RIGHT BOTTOM LEFT

Permitted whitelisted_string Values:

auto

Reference: https://developer.mozilla.org/en-US/docs/Web/CSS/border-image-width

CONTAINER_BORDER_IMAGE_OUTSET

Controls where the border image appears in relation to the edges of the container. Higher values = further away.

Max Length: 64

Max Values Accepted: 4

Validate One: whitelisted_stringcss_size

Requires: CONTAINER_BORDER_IMAGECONTAINER_BORDER_IMAGE_WIDTH

Units and Ranges For css_size:

no-unit : 0 - 20 || Decimals: 0
px : 0 - 30 || Decimals: 0

Value Mapping:

All sides
TOP BOTTOM
TOP LEFT+RIGHT BOTTOM
TOP RIGHT BOTTOM LEFT

Permitted whitelisted_string Values:

auto

Reference: https://developer.mozilla.org/en-US/docs/Web/CSS/border-image-outset

CONTAINER_BORDER_IMAGE_REPEAT

Whether the image repeats or not throughout the border, and how

Max Length: 32

Max Values Accepted: 2

Validate One: whitelisted_string

Requires: CONTAINER_BORDER_IMAGECONTAINER_BORDER_IMAGE_WIDTH

Value Mapping:

All sides
TOP+MIDDLE+BOTTOM LEFT+RIGHT

Permitted whitelisted_string Values:

stretch
repeat
round
space

Reference: https://developer.mozilla.org/en-US/docs/Web/CSS/border-image-repeat

CONTAINER_BORDER_COLOR

The color of the border.

Max Length: 120

Max Values Accepted: 4

Validate One: color_namecolor_hexcolor_rgba

Requires: CONTAINER_BORDER_WIDTHCONTAINER_BORDER_STYLE

Value Mapping:

All sides
TOP BOTTOM
TOP LEFT+RIGHT BOTTOM
TOP RIGHT BOTTOM LEFT

CONTAINER_BORDER_WIDTH

The thickness of the border.

Max Length: 64

Max Values Accepted: 4

Validate All: css_size

Requires: CONTAINER_BORDER_STYLE

Units and Ranges For css_size:

px : 0 - 40 || Decimals: 0
% : 0 - 15 || Decimals: 3
vh : 0 - 5 || Decimals: 4
hw : 0 - 5 || Decimals: 4
rem : 0 - 4 || Decimals: 4

Value Mapping:

All sides
TOP BOTTOM
TOP LEFT+RIGHT BOTTOM
TOP RIGHT BOTTOM LEFT

CONTAINER_BORDER_STYLE

The appearance style of the border.

Max Length: 64

Max Values Accepted: 4

Validate All: whitelisted_string

Requires: CONTAINER_BORDER_WIDTH

Permitted whitelisted_string Values:

dotted
dashed
solid
double
groove
ridge
inset
outset

CONTAINER_BORDER_RADIUS

Curves the sides of the container. This can be used without setting any borders at all.

Max Length: 64

Max Values Accepted: 4

Validate All: css_size

Units and Ranges For css_size:

px : 0 - 200 || Decimals: 0
% : 0 - 50 || Decimals: 3
vh : 0 - 40 || Decimals: 4
hw : 0 - 40 || Decimals: 4
rem : 0 - 30 || Decimals: 4

Value Mapping:

All sides
TOP BOTTOM
TOP LEFT+RIGHT BOTTOM
TOP RIGHT BOTTOM LEFT

Reference: https://developer.mozilla.org/en-US/docs/Web/CSS/border-radius

CONTAINER_SHADOW_COLOR

The color of the shadow.

Max Length: 32

Max Values Accepted: 1

Validate One: color_namecolor_hexcolor_rgba

Requires One: CONTAINER_SHADOW_OFFSETCONTAINER_SHADOW_SPREADCONTAINER_SHADOW_BLUR

CONTAINER_SHADOW_OFFSET

The amount the shadow offsets from the container, first along, then up/down

Max Length: 32

Max Values Accepted: 2

Validate All: css_size

Requires: CONTAINER_SHADOW_COLOR

Units and Ranges For css_size:

px : -15 - 15 || Decimals: 0
% : -5 - 5 || Decimals: 3
vh : -2 - 2 || Decimals: 4
hw : -2 - 2 || Decimals: 4
rem : -4 - 2 || Decimals: 4

Value Mapping:

Offset-X+Offset-Y
Offset-X Offset-Y

CONTAINER_SHADOW_SPREAD

The spread (thickness) of the shadow. Think of this like a border size that becomes a shadow with blur.

Max Length: 12

Max Values Accepted: 1

Validate All: css_size

Requires: CONTAINER_SHADOW_COLOR

Units and Ranges For css_size:

px : 0 - 30 || Decimals: 0
% : 0 - 10 || Decimals: 3
vh : 0 - 5 || Decimals: 4
hw : 0 - 5 || Decimals: 4
rem : 0 - 3 || Decimals: 4

CONTAINER_SHADOW_BLUR

The blurryness of the shadow. Recommended to make this a few px at least, or the shadow will look like a border.

Max Length: 12

Max Values Accepted: 1

Validate All: css_size

Requires: CONTAINER_SHADOW_COLOR

Units and Ranges For css_size:

px : 0 - 30 || Decimals: 0
% : 0 - 10 || Decimals: 3
vh : 0 - 5 || Decimals: 4
hw : 0 - 5 || Decimals: 4
rem : 0 - 3 || Decimals: 4

GROUP: CONTENT

CONTENT_FONT

Sets the font for the page content. Any font listed on Google fonts is permitted. Copy the font name from the title on the Google fonts page and if there are any spaces, switch them for underscores. For example: Comic Neue becomes Comic_Neue.

Max Length: 1000

Max Values Accepted: 2

Validate All: font_name

Value Mapping:

Font for all content
Paragraph Headings

Reference: https://fonts.google.com/

CONTENT_FONT_WEIGHT

Sets the font weight (boldness) for the page content. If you use multiple fonts, this will apply to them in the same order. If a weight is not available from Google then your browser will try to adjust the weight itself, which may look odd!

Max Length: 24

Max Values Accepted: 2

Validate All: whitelisted_string

Value Mapping:

Font for all content
Paragraph Headings

Permitted whitelisted_string Values:

bold
bolder
lighter
normal
100
200
300
400
500
600
700
800
900

CONTENT_TEXT_DIRECTION

Setting to rtl switches the text mode to right to left, which is recommended if using a right to left language such as Arabic. If you use this with a left to right language like English it will cause odd behaviour, such as punctuation appearing at the beginning of a line.

Max Length: 7

Max Values Accepted: 1

Validate All: whitelisted_string

Permitted whitelisted_string Values:

CONTENT_TEXT_SIZE

Sets the font size, either for the whole page, or for separate types of content depending on how many Values you supply. The first Value, base, sets the root font size of the page, which you can then make use of by setting other Values as relative. It is recommended to set the base as 16px and to use rem for all other values. This will mean that you can then adjust all font sizes by changing only the base value. For example, you set the base as 16px, Heading1 as 2.5rem and Paragraph as 1rem. This then outputs Heading1 as 2.5x16=40px and Paragraph as 16x1 = 16px. Later, you decide you want to font to be larger. So you change the base to 20px. Now, Heading1 will be 2.5x20=50px and Paragraph will be 20x1=20px If you have all Values set, this will make it much easier to control!

Default Value: 16px 1rem 2.5rem 2rem 1.75rem 1.5rem 1.25rem 1rem 1rem 1rem 1rem 14px

Max Length: 128

Max Values Accepted: 12

Validate All: css_size

Units and Ranges For css_size:

no-unit : 0 - 0 || Decimals: 0
px : 8 - 64 || Decimals: 0
% : 10 - 500 || Decimals: 3
vh : 2 - 10 || Decimals: 4
hw : 2 - 10 || Decimals: 4
rem : 0.3 - 8 || Decimals: 4

Value List:

Base
Paragraphs
# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6
List item
Link
Quotes
Code

CONTENT_TEXT_ALIGN

Sets how text sits on the page, especially when there are multiple lines. Justify makes every line in a block of text take up the same width.

Default Value: left

Max Length: 7

Max Values Accepted: 1

Validate All: whitelisted_string

Permitted whitelisted_string Values:

right
center
justify

CONTENT_TEXT_SHADOW_COLOR

Sets the color of text shadow.

Max Length: 32

Max Values Accepted: 1

Validate One: color_namecolor_hexcolor_rgba

Requires: CONTENT_TEXT_SHADOW_OFFSET

CONTENT_TEXT_SHADOW_OFFSET

Sets the offset of text shadow.

Max Length: 32

Max Values Accepted: 2

Validate All: css_size

Requires: CONTENT_TEXT_SHADOW_COLOR

Units and Ranges For css_size:

px : -15 - 15 || Decimals: 0
% : -5 - 5 || Decimals: 3
vh : -2 - 2 || Decimals: 4
hw : -2 - 2 || Decimals: 4
rem : -2 - 2 || Decimals: 4

Value Mapping:

Offset-X+Offset-Y
Offset-X Offset-Y

CONTENT_TEXT_SHADOW_BLUR

Sets the blur of text shadow.

Max Length: 12

Max Values Accepted: 1

Validate All: css_size

Requires: CONTENT_TEXT_SHADOW_COLORCONTENT_TEXT_SHADOW_OFFSET

Units and Ranges For css_size:

px : 0 - 30 || Decimals: 0
% : 0 - 10 || Decimals: 3
vh : 0 - 5 || Decimals: 4
hw : 0 - 5 || Decimals: 4
rem : 0 - 3 || Decimals: 4

CONTENT_TEXT_COLOR

Sets the base text color. Inline text colors will override this.

Max Length: 128

Max Values Accepted: 2

Validate One: color_namecolor_hexcolor_rgba

Value Mapping:

All Modes
Light Dark

CONTENT_LINK_COLOR

Sets the base link color.

Max Length: 16

Max Values Accepted: 2

Validate One: color_namecolor_hexcolor_rgba

Value Mapping:

All Modes
Light Dark

CONTENT_BULLET_COLOR

Sets the bullet color for lists.

Max Length: 64

Max Values Accepted: 2

Validate One: color_namecolor_hexcolor_rgba

Value Mapping:

All Modes
Light Dark

CONTENT_LINK_BEHAVIOR

Sets whether links load in new pages, or on the same page. Internal links are Rentry URLs, external links are anything else.

Default Value: same new

Max Length: 32

Max Values Accepted: 2

Validate All: whitelisted_string

Value Mapping:

All Links
Internal External

Permitted whitelisted_string Values:

same
new

Glossary

Don't know what a term means? We'll list everything you need to know here.

Option: A metadata command, always in full capitals and with underscores for spaces, followed by the = sign. For example: PAGE_TITLE =
Value: The information you would like to apply to an Option. This is put after the first = sign and must not break to a new line.
Unit: The descriptor for a number. For example 2px means 2 pixels.
Unit: Px (Pixels): The little square dots a screen is made of. A phone normally has about 350 across and 700 down. A desktop is normally 1200-1600 by 1000.
Unit: %: The percent of the container, or of the thing it is subordinate to (such as when used as a font size unit).
Unit: no-unit: When an option allows for a bare number, it will be listed as this (as when no-unit is not available, a bare number will be read as the default unit for that option). The default unit is always no-unit when this is available.
Unit: hw (Horizontal Width): The percentage of the full width of the page for the device that is viewing. On desktop, changing the window size will affect this.
Unit: vh (Vertical Height): The percentage of the full height of the page for the device that is viewing. On desktop, changing the window size will affect this.
Unit: rem (Root EM): A relative value based on the root font size. Affected by the font itself as the value is taken from width of the font's capital M.

Standalone: /metadata-how

Back

new·what·how·langs·contacts