-
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
5 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-9224018205432249" crossorigin="anonymous"></script> | ||
<script async src="https://track.webpulseanalytics.com/client/653eb2fc048754e8b13f0770" type="module"></script> | ||
<!--<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-9224018205432249" crossorigin="anonymous"></script>--> | ||
<!--<script async src="https://track.webpulseanalytics.com/client/653eb2fc048754e8b13f0770" type="module"></script>--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,7 +13,7 @@ If you have experience with software packaging, your contribution can greatly en | |
- Pup must be packaged to run using the command `pup`. | ||
|
||
- Pup can be compiled into an executable prior to packaging using `deno compile`. The procedure is described at | ||
[https://deno.com/[email protected]/tools/compiler](https://deno.com/[email protected]/tools/compiler). The command should be similar to | ||
[https://docs.deno.com/runtime/reference/cli/compiler/](https://docs.deno.com/runtime/reference/cli/compiler/). The command should be similar to | ||
`deno compile --allow-all --reload --output pup pup.ts --external-installer`. | ||
|
||
- The `--external-installer` argument to the Pup script disables the built-in installer, hiding `setup` and `upgrade` options from `--help`. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -165,36 +165,6 @@ To change default behavior of the global watcher, use the following properties w | |
} | ||
``` | ||
|
||
### Plugins | ||
|
||
> **Note**: If you are interested in developing a custom plugin, there is a [guide](/pup/examples/plugins/README.html) and | ||
> [example](https://github.com/Hexagon/pup/blob/main/docs/src/examples/plugins/log-interceptor.ts) available. { .note } | ||
To activate plugins, add your plugins to the configuration using this pattern: | ||
|
||
```json | ||
{ | ||
/* ... */ | ||
"processes": [/* ... */], | ||
"plugins": [ | ||
/* Remote plugin ... */ | ||
{ | ||
"url": "jsr:@scope/[email protected]/mod.ts", | ||
"options": { | ||
/* Plugin specific configuration */ | ||
} | ||
}, | ||
/* ... or local plugin. */ | ||
{ | ||
"url": "./plugins/app-plugin.ts", | ||
"options": { | ||
/* Plugin specific configuration */ | ||
} | ||
} | ||
] | ||
} | ||
``` | ||
|
||
### API | ||
|
||
The API configuration object is optional, and is used to customize the Rest API used to interact with Pup. Here's a breakdown of the available properties: | ||
|
@@ -207,8 +177,8 @@ The API configuration object is optional, and is used to customize the Rest API | |
|
||
By default, the API is only exposed to localhost, and will listen on a random port. | ||
|
||
If you want to use the API remotely, you can supply a specific port (one per instance) and set hostname to `0.0.0.0`. It is highly recommended to use a proxy such as nginx to expose the API to the | ||
internet. | ||
If you want to use the API remotely, you can supply a specific port (one per instance) and set hostname to `0.0.0.0`. It is highly recommended to use a proxy such as nginx, and applying additional | ||
security measures, if exposing the API to the internet. | ||
|
||
**Example, listening on port 9000 of all interfaces:** | ||
|
||
|