Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #12

Merged
merged 1 commit into from
Apr 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,25 +59,26 @@ Thank you, and we hope you have fun with it!

**Note: This module is only compatible with Caddy 2, which is currently in beta.**

First, clone this repository:
First, the [xcaddy](https://github.com/caddyserver/xcaddy) command:

```
$ git clone github.com/caddyserver/nginx-adapter caddy-nginx-adapter
```shell
$ go get -u github.com/caddyserver/xcaddy/cmd/xcaddy
```

Move into the cloned directory:
Use the command in the following format:

```
$ cd caddy-nginx-adapter
```shell
$ xcaddy build <version>
[--output <file>]
[--with <module[@version]>...]
```

Then run:
For example:

```shell
$ xcaddy build v2.0.0-beta.20 \
--with github.com/caddyserver/nginx-adapter@580d27d4d7cb0351b3f25cc9e79850344782afcf
```
$ ./build_caddy.sh
```

The script will create a directory named `caddy`, and the custom built Caddy executable is inside it and named `caddy_v2`.

## Use

Expand Down
15 changes: 0 additions & 15 deletions build_caddy.sh

This file was deleted.

2 changes: 1 addition & 1 deletion directives/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Problem

The NGINX documentation is broken up per module. Every module lists its directives and each directive lists the contexts where it can be used. The development of the adapter requires listing of directives broken up by contexts rather than by module. For example, we need the answer to questions of the form:
The NGINX documentation is broken up per module. Every module lists its directives and each directive lists the contexts where it can be used. The development of the adapter requires listing of directives broken up by contexts rather than by module. In other words, we need the answer to questions of the form:

Given the context X, what directives are usable within it?

Expand Down