Set up your website (legacy method)
+Set up your website (with CI)
- This is currently the only method which supports custom domains. Support for custom domains with the new method is coming soon. + If you use a static site generator like Jekyll, Hugo, or any other similar tool, you can integrate deployment into the Forgejo Actions workflow which builds your site. +
++ To learn how to do this, see our documentation. +
+ +Set up your website (without CI)
++ If you just want to serve plain old hand-made static files, you can also configure a webhook on your repository to deploy changes to Codeberg Pages.
-Show the legacy method
-- 1 - Set up your repository -
-
- Create a public repository named pages to make the site available at the main subdomain.
-
or
- Create a branch pages in a public repository:
- git switch --orphan pagesgit rm --cached -r .
-
- 2 - Upload your files -
-- Push your static content, HTML, style, fonts, images or anything else. -
- -- 3 - You're done! -
-
- Access your new website using this link:
- https://USERNAME.codeberg.page[/REPOSITORY][/@BRANCH]
-
or
- To use a custom domain, create a file .domains in your repository with the domain name you wish to use.
-
- Then, add a DNS record for that domain:
- CNAME [[branch.]repo.]user.codeberg.page.
-
- Or for apex domains where CNAME doesn't work:
- ALIAS codeberg.page.
- TXT [[branch.]repo.]user.codeberg.page
-
- If ALIAS isn't supported, use add the TXT record as described above, and use A+AAAA as following:
-
- A 217.197.84.141
- AAAA 2a0a:4580:103f:c0de::2
-
Set up your website (new method without CI)
- Set the Target URL to https://USERNAME.codeberg.page/REPOSITORY, replacing USERNAME with your user or organization name and REPOSITORY with the name of your repository.
+ Set the Target URL to the URL of your website. If you don’t have a custom domain, that’s https://USERNAME.codeberg.page/REPOSITORY, replacing USERNAME with your user or organization name and REPOSITORY with the name of your repository.
(If your repository is called pages, omit it.)
+ If you have a custom domain, remember to configure it with the instructions below.
Set the Branch filter to pages.
@@ -243,12 +183,25 @@
Set up your website (new method with CI)
+Custom domain configuration
- If you use a static site generator like Jekyll, Hugo, or any other similar tool, you can integrate deployment into the Forgejo Actions workflow which builds your site instead of using the webhook.
+ To use a custom domain, create a file .domains in your pages branch with the domain name you wish to use.
- To learn how to do this, see our documentation.
+ Then, add a DNS record for that domain:
+ CNAME [[branch.]repo.]user.codeberg.page.
+
+ Or for apex domains where CNAME doesn't work:
+ ALIAS codeberg.page.
+ TXT [[branch.]repo.]user.codeberg.page
+
+ If ALIAS isn't supported, use add the TXT record as described above, and use A+AAAA as following:
+
+ A 217.197.84.141
+ AAAA 2a0a:4580:103f:c0de::2