Skip to content

Commit 879d9b1

Browse files
authored
Extend readme section for docker (#97)
1 parent fd7a3b6 commit 879d9b1

File tree

6 files changed

+38
-11
lines changed

6 files changed

+38
-11
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,5 @@ cert.pem
66
key.pem
77
.env*
88
.vscode
9+
helm-releases/.DS_Store
10+
.DS_Store

README.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,23 +85,48 @@ For complete Parseable API documentation, refer to [Parseable API workspace on P
8585

8686
: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.
8787
## Getting Started
88+
### Docker
89+
Parseable docker image is available on [Docker hub](https://hub.docker.com/r/parseable/parseable).
8890

91+
```sh
92+
mkdir -p /tmp/parseable
93+
docker run \
94+
-p 8000:8000 \
95+
-v /tmp/parseable:/data \
96+
parseable/parseable:v0.0.1
97+
```
98+
99+
### Binary
89100
Parseable binary is available on [Github releases](https://github.com/parseablehq/parseable/releases). Please download the latest release for your platform.
90101

91102
```sh
92103
chmod +x parseable
93-
export P_S3_URL="https://minio.parseable.io:9000"
94-
export P_S3_ACCESS_KEY="minioadmin"
95-
export P_S3_SECRET_KEY="minioadmin"
96-
export P_S3_REGION="us-east-1"
97-
export P_S3_BUCKET="parseable"
98104
./parseable
99105
```
100106

107+
<h1></h1>
108+
109+
Parseable dashboard is available at [http://localhost:8000](http://localhost:8000). Default username and password is `parseable`.
110+
101111
By default Parseable uses a public bucket to store the data. Please change the object storage credentials to your own bucket, before using Parseable.
102112

103113
: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).
104114

115+
### Configuration
116+
117+
Parseable can be configured using environment variables listed below, with sample values.
118+
119+
```sh
120+
export P_S3_URL="https://minio.parseable.io:9000"
121+
export P_S3_ACCESS_KEY="minioadmin"
122+
export P_S3_SECRET_KEY="minioadmin"
123+
export P_S3_REGION="us-east-1"
124+
export P_S3_BUCKET="parseable"
125+
export P_LOCAL_STORAGE="./data"
126+
export P_USERNAME="parseable"
127+
export P_PASSWORD="parseable"
128+
```
129+
105130
## Contributing
106131

107132
Refer to the contributing guide [here](https://www.parseable.io/docs/contributing).

helm-releases/collector-0.0.1.tgz

8 Bytes
Binary file not shown.

helm-releases/parseable-0.0.1.tgz

-1 Bytes
Binary file not shown.

helm/parseable/values.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ parseable:
44
repository: parseable/parseable
55
tag: v0.0.1
66
pullPolicy: IfNotPresent
7-
tag: ""
87
env:
98
P_ADDR: "0.0.0.0:8000"
109
P_TLS_CERT_PATH: ""

index.yaml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@ apiVersion: v1
22
entries:
33
collector:
44
- apiVersion: v2
5-
created: "2022-09-03T07:49:20.635612+05:30"
5+
appVersion: 4769fbf
6+
created: "2022-09-08T18:21:10.789695+05:30"
67
description: Helm chart for Parseable Collector
7-
digest: b9d6d348335af317629d1d11f48ea8ab9b174e2610efff323908b3b955f21aee
8+
digest: d2cfcc9ec4ccdbaa53fe7ac1c9e5b9083f37f12d141a055298d9c800d1e3d566
89
name: collector
910
type: application
1011
urls:
@@ -13,12 +14,12 @@ entries:
1314
parseable:
1415
- apiVersion: v2
1516
appVersion: v0.0.1
16-
created: "2022-09-03T07:49:20.636087+05:30"
17+
created: "2022-09-08T18:21:10.790129+05:30"
1718
description: Helm chart for Parseable Server
18-
digest: e62c672829b96097ca89e8316f66f7fbae3b4f7d8abee71138befac17881b969
19+
digest: 1f1142db092b9620ee38bb2294ccbb1c17f807b33bf56da43816af7fe89f301e
1920
name: parseable
2021
type: application
2122
urls:
2223
- https://charts.parseable.io/helm-releases/parseable-0.0.1.tgz
2324
version: 0.0.1
24-
generated: "2022-09-03T07:49:20.634697+05:30"
25+
generated: "2022-09-08T18:21:10.7888+05:30"

0 commit comments

Comments
 (0)