From 711f12ed273bf2995e599a8003c9bf36787ae35f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Paul=20T=C3=B6tterman?= Date: Sat, 15 Oct 2022 22:25:07 +0300 Subject: [PATCH] More spelling & style fixes (#1275) --- docs/docs/30-administration/00-setup.md | 6 +++--- .../30-administration/10-server-config.md | 4 ++-- .../100-external-configuration-api.md | 4 ++-- .../11-forges/60-bitbucket_server.md | 2 +- .../22-backends/10-docker.md | 2 +- .../30-administration/22-backends/20-local.md | 2 +- docs/docs/30-administration/30-database.md | 12 +++++------ docs/docs/30-administration/60-ssl.md | 2 +- docs/docs/30-administration/70-proxy.md | 20 +++++++++---------- docs/docs/30-administration/90-prometheus.md | 4 ++-- 10 files changed, 29 insertions(+), 29 deletions(-) diff --git a/docs/docs/30-administration/00-setup.md b/docs/docs/30-administration/00-setup.md index 5176d201d..677d8a0b4 100644 --- a/docs/docs/30-administration/00-setup.md +++ b/docs/docs/30-administration/00-setup.md @@ -2,7 +2,7 @@ A Woodpecker deployment consists of two parts: -- A server which is the heart of Woodpecker and ships the webinterface. +- A server which is the heart of Woodpecker and ships the web interface. - Next to one server you can deploy any number of agents which will run the pipelines. > Each agent is able to process one pipeline step by default. @@ -128,11 +128,11 @@ See the complete reference for all supported forges [here](./11-forges/10-overvi ## Database -By default Woodpecker uses a sqlite database which requires zero installation or configuration. See the [database settings](./30-database.md) page to further configure it or use MySQL or Postgres. +By default Woodpecker uses a SQLite database which requires zero installation or configuration. See the [database settings](./30-database.md) page to further configure it or use MySQL or Postgres. ## SSL -Woodpecker supports ssl configuration by using Let's encrypt or by using own certificates. See the [SSL guide](./60-ssl.md). +Woodpecker supports SSL configuration by using Let's encrypt or by using own certificates. See the [SSL guide](./60-ssl.md). ## Metrics diff --git a/docs/docs/30-administration/10-server-config.md b/docs/docs/30-administration/10-server-config.md index d769dea46..806f791d4 100644 --- a/docs/docs/30-administration/10-server-config.md +++ b/docs/docs/30-administration/10-server-config.md @@ -127,7 +127,7 @@ Disable colored debug output. ### `WOODPECKER_HOST` > Default: empty -Server fully qualified url of the user-facing hostname. +Server fully qualified URL of the user-facing hostname. Example: `WOODPECKER_HOST=http://woodpecker.example.org` @@ -272,7 +272,7 @@ The database driver name. Possible values are `sqlite3`, `mysql` or `postgres`. ### `WOODPECKER_DATABASE_DATASOURCE` > Default: `woodpecker.sqlite` -The database connection string. The default value is the path of the embedded sqlite database file. +The database connection string. The default value is the path of the embedded SQLite database file. Example: ```bash diff --git a/docs/docs/30-administration/100-external-configuration-api.md b/docs/docs/30-administration/100-external-configuration-api.md index d8c4d7250..4d249e34c 100644 --- a/docs/docs/30-administration/100-external-configuration-api.md +++ b/docs/docs/30-administration/100-external-configuration-api.md @@ -1,7 +1,7 @@ # External Configuration API -To provide additional management and preprocessing capabilities for pipeline configurations Woodpecker supports an HTTP api which can be enabled to call an external config service. -Before the run or restart of any pipeline Woodpecker will make a POST request to an external HTTP api sending the current repository, build information and all current config files retrieved from the repository. The external api can then send back new pipeline configurations that will be used immediately or respond with `HTTP 204` to tell the system to use the existing configuration. +To provide additional management and preprocessing capabilities for pipeline configurations Woodpecker supports an HTTP API which can be enabled to call an external config service. +Before the run or restart of any pipeline Woodpecker will make a POST request to an external HTTP API sending the current repository, build information and all current config files retrieved from the repository. The external API can then send back new pipeline configurations that will be used immediately or respond with `HTTP 204` to tell the system to use the existing configuration. Every request sent by Woodpecker is signed using a [http-signature](https://datatracker.ietf.org/doc/html/draft-cavage-http-signatures) by a private key (ed25519) generated on the first start of the Woodpecker server. You can get the public key for the verification of the http-signature from `http(s)://your-woodpecker-server/api/signature/public-key`. diff --git a/docs/docs/30-administration/11-forges/60-bitbucket_server.md b/docs/docs/30-administration/11-forges/60-bitbucket_server.md index 79ddcf22d..d73b5fe87 100644 --- a/docs/docs/30-administration/11-forges/60-bitbucket_server.md +++ b/docs/docs/30-administration/11-forges/60-bitbucket_server.md @@ -88,7 +88,7 @@ services: ## Service Account -Woodpecker uses `git+https` to clone repositories, however, Bitbucket Server does not currently support cloning repositories with oauth token. To work around this limitation, you must create a service account and provide the username and password to Woodpecker. This service account will be used to authenticate and clone private repositories. +Woodpecker uses `git+https` to clone repositories, however, Bitbucket Server does not currently support cloning repositories with OAuth token. To work around this limitation, you must create a service account and provide the username and password to Woodpecker. This service account will be used to authenticate and clone private repositories. ## Registration diff --git a/docs/docs/30-administration/22-backends/10-docker.md b/docs/docs/30-administration/22-backends/10-docker.md index 7de0d0a15..f69d16186 100644 --- a/docs/docs/30-administration/22-backends/10-docker.md +++ b/docs/docs/30-administration/22-backends/10-docker.md @@ -34,4 +34,4 @@ RUN apk add -U --no-cache docker-credential-ecr-login ## Podman support -While the agent was developed with Docker/Moby, Podman can also be used by setting the environment variable `DOCKER_SOCK` to point to the podman socket. In order to work without workarounds, Podman 4.0 (or above) is required. +While the agent was developed with Docker/Moby, Podman can also be used by setting the environment variable `DOCKER_SOCK` to point to the Podman socket. In order to work without workarounds, Podman 4.0 (or above) is required. diff --git a/docs/docs/30-administration/22-backends/20-local.md b/docs/docs/30-administration/22-backends/20-local.md index 5caf79432..76f589eb5 100644 --- a/docs/docs/30-administration/22-backends/20-local.md +++ b/docs/docs/30-administration/22-backends/20-local.md @@ -63,7 +63,7 @@ WOODPECKER_SERVER=replace_with_your_server_address:9000 ## Running the agent -Start the agent from the directory with the `.env` file: +Start the agent from the directory with the `.env` file: `woodpecker-agent` diff --git a/docs/docs/30-administration/30-database.md b/docs/docs/30-administration/30-database.md index af422784a..94dc84fbc 100644 --- a/docs/docs/30-administration/30-database.md +++ b/docs/docs/30-administration/30-database.md @@ -2,9 +2,9 @@ The default database engine of Woodpecker is an embedded SQLite database which requires zero installation or configuration. But you can replace it with a MySQL/MariaDB or Postgres database. -## Configure sqlite +## Configure SQLite -By default Woodpecker uses a sqlite database stored under `/var/lib/woodpecker/`. You can mount a [data volume](https://docs.docker.com/storage/volumes/#create-and-manage-volumes) to persist the sqlite database. +By default Woodpecker uses a SQLite database stored under `/var/lib/woodpecker/`. You can mount a [data volume](https://docs.docker.com/storage/volumes/#create-and-manage-volumes) to persist the SQLite database. ```diff # docker-compose.yml @@ -19,7 +19,7 @@ services: ## Configure MySQL/MariaDB -The below example demonstrates mysql database configuration. See the official driver [documentation](https://github.com/go-sql-driver/mysql#dsn-data-source-name) for configuration options and examples. +The below example demonstrates MySQL database configuration. See the official driver [documentation](https://github.com/go-sql-driver/mysql#dsn-data-source-name) for configuration options and examples. ```diff # docker-compose.yml @@ -35,8 +35,8 @@ services: ## Configure Postgres -The below example demonstrates postgres database configuration. See the official driver [documentation](https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING) for configuration options and examples. -Please use postgres versions equal or higher than **11**. +The below example demonstrates Postgres database configuration. See the official driver [documentation](https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING) for configuration options and examples. +Please use Postgres versions equal or higher than **11**. ```diff # docker-compose.yml @@ -52,7 +52,7 @@ services: ## Database Creation -Woodpecker does not create your database automatically. If you are using the mysql or postgres driver you will need to manually create your database using `CREATE DATABASE` +Woodpecker does not create your database automatically. If you are using the MySQL or Postgres driver you will need to manually create your database using `CREATE DATABASE` ## Database Migration diff --git a/docs/docs/30-administration/60-ssl.md b/docs/docs/30-administration/60-ssl.md index 3c5af62a5..7174d6e41 100644 --- a/docs/docs/30-administration/60-ssl.md +++ b/docs/docs/30-administration/60-ssl.md @@ -42,7 +42,7 @@ Woodpecker uses the official Go acme library which will handle certificate upgra ## SSL with own certificates -Woodpecker supports ssl configuration by mounting certificates into your container. +Woodpecker supports SSL configuration by mounting certificates into your container. ```diff # docker-compose.yml diff --git a/docs/docs/30-administration/70-proxy.md b/docs/docs/30-administration/70-proxy.md index a80774c26..4a224ad34 100644 --- a/docs/docs/30-administration/70-proxy.md +++ b/docs/docs/30-administration/70-proxy.md @@ -33,7 +33,7 @@ ProxyPassReverse / http://127.0.0.1:8000/ ## Nginx -This guide provides a basic overview for installing Woodpecker server behind the nginx web-server. For more advanced configuration options please consult the official nginx [documentation](https://www.nginx.com/resources/admin-guide/). +This guide provides a basic overview for installing Woodpecker server behind the Nginx web-server. For more advanced configuration options please consult the official Nginx [documentation](https://www.nginx.com/resources/admin-guide/). Example configuration: @@ -104,12 +104,12 @@ After installing [ngrok](https://ngrok.com/), open a new console and run: ngrok http 8000 ``` -Set `WOODPECKER_HOST` (for example in `docker-compose.yml`) to the ngrok url (usually xxx.ngrok.io) and start the server. +Set `WOODPECKER_HOST` (for example in `docker-compose.yml`) to the ngrok URL (usually xxx.ngrok.io) and start the server. ## Traefik -To install the Woodpecker server behind a [traefik](https://traefik.io/) load balancer, you must expose both the `http` and the `gRPC` ports. Here is a comprehensive example, considering you are running traefik with docker swarm and want to do TLS termination and automatic redirection from http to https. +To install the Woodpecker server behind a [Traefik](https://traefik.io/) load balancer, you must expose both the `http` and the `gRPC` ports. Here is a comprehensive example, considering you are running Traefik with docker swarm and want to do TLS termination and automatic redirection from http to https. ```yml version: '3.8' @@ -121,7 +121,7 @@ services: - WOODPECKER_OPEN=true - WOODPECKER_ADMIN=your_admin_user # other settings ... - + networks: - dmz # externally defined network, so that traefik can connect to the server volumes: @@ -130,7 +130,7 @@ services: deploy: labels: - traefik.enable=true - + # web server - traefik.http.services.woodpecker-service.loadbalancer.server.port=8000 @@ -147,8 +147,8 @@ services: - traefik.http.middlewares.woodpecker-redirect.redirectscheme.scheme=https - traefik.http.middlewares.woodpecker-redirect.redirectscheme.permanent=true - traefik.http.routers.woodpecker.middlewares=woodpecker-redirect@docker - - # gRPC service + + # gRPC service - traefik.http.services.woodpecker-grpc.loadbalancer.server.port=9000 - traefik.http.services.woodpecker-grpc.loadbalancer.server.scheme=h2c @@ -165,14 +165,14 @@ services: - traefik.http.middlewares.woodpecker-grpc-redirect.redirectscheme.scheme=https - traefik.http.middlewares.woodpecker-grpc-redirect.redirectscheme.permanent=true - traefik.http.routers.woodpecker-grpc.middlewares=woodpecker-grpc-redirect@docker - - + + volumes: woodpecker-server-data: driver: local networks: - dmz: + dmz: external: true ``` diff --git a/docs/docs/30-administration/90-prometheus.md b/docs/docs/30-administration/90-prometheus.md index 75d1aa1f4..3cd28640d 100644 --- a/docs/docs/30-administration/90-prometheus.md +++ b/docs/docs/30-administration/90-prometheus.md @@ -16,7 +16,7 @@ scrape_configs: ## Authorization -An administrator will need to generate a user api token and configure in the prometheus configuration file as a bearer token. Please see the following example: +An administrator will need to generate a user API token and configure in the Prometheus configuration file as a bearer token. Please see the following example: ```diff global: @@ -32,7 +32,7 @@ scrape_configs: ## Metric Reference -List of prometheus metrics specific to Woodpecker: +List of Prometheus metrics specific to Woodpecker: ``` # HELP woodpecker_build_count Build count.