Skip to content

Commit

Permalink
Extend readme section for docker (#97)
Browse files Browse the repository at this point in the history
  • Loading branch information
nitisht authored Sep 8, 2022
1 parent fd7a3b6 commit 879d9b1
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 11 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@ cert.pem
key.pem
.env*
.vscode
helm-releases/.DS_Store
.DS_Store
35 changes: 30 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,23 +85,48 @@ For complete Parseable API documentation, refer to [Parseable API workspace on P

:exclamation: Please do not store any sensitive data on this server as the data is openly accessible. We'll delete the data on this server periodically.
## Getting Started
### Docker
Parseable docker image is available on [Docker hub](https://hub.docker.com/r/parseable/parseable).

```sh
mkdir -p /tmp/parseable
docker run \
-p 8000:8000 \
-v /tmp/parseable:/data \
parseable/parseable:v0.0.1
```

### Binary
Parseable binary is available on [Github releases](https://github.com/parseablehq/parseable/releases). Please download the latest release for your platform.

```sh
chmod +x parseable
export P_S3_URL="https://minio.parseable.io:9000"
export P_S3_ACCESS_KEY="minioadmin"
export P_S3_SECRET_KEY="minioadmin"
export P_S3_REGION="us-east-1"
export P_S3_BUCKET="parseable"
./parseable
```

<h1></h1>

Parseable dashboard is available at [http://localhost:8000](http://localhost:8000). Default username and password is `parseable`.

By default Parseable uses a public bucket to store the data. Please change the object storage credentials to your own bucket, before using Parseable.

:memo: Parseable is in alpha stage and will evolve over time. There may be breaking changes between releases. Please give us your feedback in [Slack](https://launchpass.com/parseable), or [Issues](https://github.com/parseablehq/parseable/issues/new).

### Configuration

Parseable can be configured using environment variables listed below, with sample values.

```sh
export P_S3_URL="https://minio.parseable.io:9000"
export P_S3_ACCESS_KEY="minioadmin"
export P_S3_SECRET_KEY="minioadmin"
export P_S3_REGION="us-east-1"
export P_S3_BUCKET="parseable"
export P_LOCAL_STORAGE="./data"
export P_USERNAME="parseable"
export P_PASSWORD="parseable"
```

## Contributing

Refer to the contributing guide [here](https://www.parseable.io/docs/contributing).
Expand Down
Binary file modified helm-releases/collector-0.0.1.tgz
Binary file not shown.
Binary file modified helm-releases/parseable-0.0.1.tgz
Binary file not shown.
1 change: 0 additions & 1 deletion helm/parseable/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ parseable:
repository: parseable/parseable
tag: v0.0.1
pullPolicy: IfNotPresent
tag: ""
env:
P_ADDR: "0.0.0.0:8000"
P_TLS_CERT_PATH: ""
Expand Down
11 changes: 6 additions & 5 deletions index.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@ apiVersion: v1
entries:
collector:
- apiVersion: v2
created: "2022-09-03T07:49:20.635612+05:30"
appVersion: 4769fbf
created: "2022-09-08T18:21:10.789695+05:30"
description: Helm chart for Parseable Collector
digest: b9d6d348335af317629d1d11f48ea8ab9b174e2610efff323908b3b955f21aee
digest: d2cfcc9ec4ccdbaa53fe7ac1c9e5b9083f37f12d141a055298d9c800d1e3d566
name: collector
type: application
urls:
Expand All @@ -13,12 +14,12 @@ entries:
parseable:
- apiVersion: v2
appVersion: v0.0.1
created: "2022-09-03T07:49:20.636087+05:30"
created: "2022-09-08T18:21:10.790129+05:30"
description: Helm chart for Parseable Server
digest: e62c672829b96097ca89e8316f66f7fbae3b4f7d8abee71138befac17881b969
digest: 1f1142db092b9620ee38bb2294ccbb1c17f807b33bf56da43816af7fe89f301e
name: parseable
type: application
urls:
- https://charts.parseable.io/helm-releases/parseable-0.0.1.tgz
version: 0.0.1
generated: "2022-09-03T07:49:20.634697+05:30"
generated: "2022-09-08T18:21:10.7888+05:30"

0 comments on commit 879d9b1

Please sign in to comment.