mirrors/git-pages
1
0
Fork 0
mirror of https://codeberg.org/git-pages/git-pages.git synced 2026-08-17 01:16:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

README: accommodate installation from Docker/binary/etc

Browse Source 
Reviewed-on: https://codeberg.org/git-pages/git-pages/pulls/250
Reviewed-by: Catherine <whitequark@whitequark.org>
This commit is contained in:
Psy-Q
2026-07-30 17:46:53 +02:00
committed by Catherine
parent e02c8dd138
commit 472ae7ecaf
1 changed files with 16 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+16 -3
View File
@@ -47,15 +47,28 @@ You can install _git-pages_ using one of the following methods:
Usage
-----
First, [install the software](#installation). Then run:
First, [install the software](#installation).
If you installed from a cloned repository or from a tarball, copy the sample config file:
```console
$ cp config/config.example.toml config.toml
```
If you are using the binary, a package, or the Docker install, you need to retrieve a sample config file separately:
```console
$ curl -o config.toml https://codeberg.org/git-pages/git-pages/raw/branch/main/conf/config.example.toml
```
Then run:
```console
$ mkdir -p data
$ cp conf/config.example.toml config.toml
$ PAGES_INSECURE=1 git-pages
```
These commands starts an HTTP server on `0.0.0.0:3000` and use the `data` directory for persistence. **Authentication is disabled via `PAGES_INSECURE=1`** to avoid the need to set up a DNS server as well; never enable `PAGES_INSECURE=1` in production.
These commands start an HTTP server on `0.0.0.0:3000` and use the `data` directory for persistence. **Authentication is disabled via `PAGES_INSECURE=1`** to avoid the need to set up a DNS server as well; never enable `PAGES_INSECURE=1` in production.
To publish a site, run the following commands (consider also using the [git-pages-cli] tool):