mirrors/woodpecker
1
0
Fork 0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2024-12-21 07:56:31 +00:00
Code Issues Projects Releases Wiki Activity
woodpecker/docs
History
Marian Steinbach 17b8867b96
Clean up config environment variables for server and agent (#218) 
The goal here is to make consistent use of configuration environment variables prefixed `WOODPECKER_`. Where several variants existed, this PR aims to remove all but one option, leaving the most explicit.

This PR only changes server and agent code, but not documentation, in order to keep the PR digestible. Once we have consensus that this is correct, I'll change docs accordingly.

User (rather: admin) facing changes in this PR:

- In general, support for all server and agent config environment variables (env vars) starting with `DRONE_` is removed. The according `WOODPECKER_*` variables must be used instead.
- The env var `WOODPECKER_HOST` replaces `DRONE_HOST`, and `DRONE_SERVER_HOST`.
- The env var `WOODPECKER_AGENT_SECRET` is used to configure the shared secret which agents use to authenticate against the server. It replaces `WOODPECKER_SECRET`, `DRONE_SECRET`, `WOODPECKER_PASSWORD`, `DRONE_PASSWORD`, and `DRONE_AGENT_SECRET`.
- The env var `WOODPECKER_DATABASE_DRIVER` replaces `DRONE_DATABASE_DRIVER` and `DATABASE_DRIVER`.
- The env var `WOODPECKER_DATABASE_DATASOURCE` replaces `DRONE_DATABASE_DATASOURCE` and `DATABASE_CONFIG`.
2021-09-28 15:43:44 +02:00
..
docs Clean up config environment variables for server and agent (#218) 2021-09-28 15:43:44 +02:00
src [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
static [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
.gitignore [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
babel.config.js [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
docusaurus.config.js Improve administration docs (#307) 2021-09-16 18:50:53 +02:00
LICENSE Optimize license files (#355) 2021-09-25 15:15:54 +02:00
package.json [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
README.md Improve administration docs (#307) 2021-09-16 18:50:53 +02:00
sidebars.js [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
yarn.lock [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Deployment happen via CI to woodpecker-ci.github.io.

To manually build the website and push it exec:

GIT_USER=woodpecker-bot USE_SSH=true DEPLOYMENT_BRANCH=master yarn deploy