You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-5Lines changed: 30 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -85,23 +85,48 @@ For complete Parseable API documentation, refer to [Parseable API workspace on P
85
85
86
86
: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.
87
87
## Getting Started
88
+
### Docker
89
+
Parseable docker image is available on [Docker hub](https://hub.docker.com/r/parseable/parseable).
88
90
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
89
100
Parseable binary is available on [Github releases](https://github.com/parseablehq/parseable/releases). Please download the latest release for your platform.
90
101
91
102
```sh
92
103
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"
98
104
./parseable
99
105
```
100
106
107
+
<h1></h1>
108
+
109
+
Parseable dashboard is available at [http://localhost:8000](http://localhost:8000). Default username and password is `parseable`.
110
+
101
111
By default Parseable uses a public bucket to store the data. Please change the object storage credentials to your own bucket, before using Parseable.
102
112
103
113
: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).
104
114
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
+
105
130
## Contributing
106
131
107
132
Refer to the contributing guide [here](https://www.parseable.io/docs/contributing).
0 commit comments