Skip to content

Commit 56a6d62

Browse files
Chore: Play with docker setup (ToolJet#3291)
* add compose file for play with docker setup * update readme for pwd deploy * add deployment platform on compose file * update readme * fix pwd link * remove volume usage * update docs with try with tooljet page * update try tooljet doc
1 parent 700705c commit 56a6d62

File tree

4 files changed

+53
-2
lines changed

4 files changed

+53
-2
lines changed

deploy/docker/play-with-docker.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
version: '3'
2+
3+
services:
4+
tooljet:
5+
tty: true
6+
stdin_open: true
7+
image: tooljet/try:latest
8+
ports:
9+
- 3000:3000
10+
environment:
11+
DEPLOYMENT_PLATFORM: "docker:pwd"

docs/docs/setup/try-tooljet.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
id: try-tooljet
3+
title: Try ToolJet
4+
---
5+
6+
# Try ToolJet
7+
## On local with Docker
8+
9+
You can run the command below to have ToolJet up and running right away.
10+
11+
```bash
12+
docker run \
13+
--name tooljet \
14+
--restart unless-stopped \
15+
-p 3000:3000 \
16+
-v tooljet_data:/var/lib/postgresql/13/main \
17+
tooljet/try:latest
18+
```
19+
20+
#### Setup information
21+
22+
- Runs the ToolJet server on the port 3000 on your machine.
23+
- Container has postgres already configured within. All the data will be available in the docker volume `tooljet_data`.
24+
- Default user credentials to login (email: `[email protected]`, password: `password`).
25+
- You can make use of `--env` or `--env-file` flag to test against various env configurables mentioned [here](https://docs.tooljet.com/docs/setup/env-vars).
26+
- Use `docker stop tooljet` to stop the container and `docker start tooljet` to start the container thereafter.
27+
28+
## On Play with docker
29+
30+
You can deploy ToolJet on PWD for free with the one-click-deployment button below.
31+
32+
<a href="https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/docker/play-with-docker.yml">
33+
<img src="https://raw.githubusercontent.com/play-with-docker/stacks/master/assets/images/button.png" alt="Try in PWD" height="32"/>
34+
</a>
35+
36+
#### Setup information
37+
38+
- Default user credentials to login (email: `[email protected]`, password: `password`).
39+
- Open port 3000 after the docker containers are up and running
40+
- Visit the url shared on the dashboard to try out tooljet

docs/docusaurus.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ module.exports = {
105105
},
106106
algolia: {
107107
appId: 'O8HQRLI0WA',
108-
apiKey: process.env.ALGOLIA_API_KEY, // Public API key: it is safe to commit it
108+
apiKey: process.env.ALGOLIA_API_KEY || 'development', // Public API key: it is safe to commit it
109109
indexName: 'tooljet',
110110
contextualSearch: true,
111111
externalUrlRegex: 'external\\.com|domain\\.com',

docs/sidebars.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ const sidebars = {
1616
label: 'Setup',
1717
link: {type: 'doc', id: 'setup/index'},
1818
items: [
19-
'setup/docker-local',
19+
'setup/try-tooljet',
2020
'setup/docker',
2121
'setup/heroku',
2222
'setup/ec2',

0 commit comments

Comments
 (0)