Skip to content

Commit

Permalink
v0.2.5
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelKreil committed Feb 26, 2024
1 parent dbffff8 commit 2a11ad5
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 33 deletions.
34 changes: 4 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ versatiles-google-cloud -f -l local/data/
```

Or clone and run the repo:

```bash
git clone https://github.com/versatiles-org/node-versatiles-google-cloud.git
cd node-versatiles-google-cloud
Expand All @@ -51,43 +52,16 @@ npm start -f -l local/data/
```

The arguments used:
- `-f` or `--fast-recompression` disables recompression, so it's faster if you're developing locally.
- `-l` or `--local-directory` uses a local directory instead of a Google Bucket.

* `-f` or `--fast-recompression` disables recompression, so it's faster if you're developing locally.
* `-l` or `--local-directory` uses a local directory instead of a Google Bucket.

Note that for security and performance reasons no file listing is implemented. If you have a file such as `local/data/app/index.html` you will need to open the correct URL in your browser to view the file: `http://localhost:8080/app/index.html`

## Options

<!--- This chapter is generated automatically --->

```console
$ versatiles-google-cloud
Usage: versatiles-google-cloud [options] <bucket-name>

Initialises a server to serve files from a specified Google Bucket to a Google
Load Balancer with CDN, handles HTTP headers and compression, and provides a
RESTful API for VersaTiles containers.
For more details, visit:
https://github.com/versatiles-org/node-versatiles-google-cloud/

Arguments:
bucket-name Name of the Google Cloud Storage bucket.

Options:
-b, --base-url <url> Set the public base URL. Defaults to
"http://localhost:<port>/".
-d, --directory <prefix> Set the bucket directory (prefix), e.g.,
"/public/".
-f, --fast-recompression Enable faster server responses by avoiding
recompression.
-l, --local-directory <path> Ignore bucket and use a local directory
instead. Useful for local development.
-p, --port <port> Set the server port. Default: 8080
-v, --verbose Enable verbose mode for detailed operational
logs.
-h, --help display help for command
```

## License

[Unlicense](./LICENSE.md)
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@versatiles/google-cloud",
"version": "0.2.4",
"version": "0.2.5",
"description": "A server for VersaTiles in Google Cloud Run",
"bin": {
"versatiles-google-cloud": "dist/index.js"
Expand Down

0 comments on commit 2a11ad5

Please sign in to comment.