2019-11-23 19:57:39 +00:00
---
path: "/docs/quick-setup"
title: "Quick Setup"
---
### Install Ruby dependencies
Use the following command to install ruby dependencies.
```bash
bundle
```
### Install JavaScript dependencies
```bash
yarn
```
This would install all required dependencies for Chatwoot application.
Please refer to [environment-variables ](./environment-variables ) to read on setting environment variables.
### Setup rails server
```bash
# run db migrations
bundle exec rake db:create
bundle exec rake db:reset
# fireup the server
foreman start -f Procfile.dev
```
### Login with credentials
```bash
http://localhost:3000
user name: john@acme.inc
password: 123456
```
### Docker for development
2019-12-05 11:12:46 +00:00
The first time you start your development environment run the following two commands:
2019-11-23 19:57:39 +00:00
```bash
2019-12-05 11:12:46 +00:00
# build and start the services
docker-compose up --build
# prepare the database
docker-compose exec server bundle exec rails db:prepare
2019-11-23 19:57:39 +00:00
```
2019-12-05 11:12:46 +00:00
Then browse http://localhost:3000
2019-11-23 20:31:13 +00:00
2019-11-23 19:57:39 +00:00
```bash
2019-12-05 11:12:46 +00:00
# To stop your environment use Control+C (on Mac) CTRL+C (on Win) or
docker-compose down
# start the services
docker-compose up
2019-11-23 19:57:39 +00:00
```
2019-12-05 11:12:46 +00:00
When you change the service’ s Dockerfile or the contents of the build directory, run stop then build. (For example after modifying package.json or Gemfile)
2019-11-23 19:57:39 +00:00
```bash
2019-12-05 11:12:46 +00:00
docker-compose stop
docker-compose build
2019-11-23 19:57:39 +00:00
```
2019-12-05 11:12:46 +00:00
The docker-compose environment consists of:
- chatwoot server
- postgres
- redis
- webpacker-dev-server
If in case you encounter a seeding issue or you want reset the database you can do it using the following command :
2019-11-23 19:57:39 +00:00
```bash
2019-12-05 11:12:46 +00:00
docker-compose run -rm server bundle exec rake db:reset
2019-11-23 19:57:39 +00:00
```
2019-12-05 11:12:46 +00:00
This command essentially runs postgres and redis containers and then run the rake command inside the chatwoot server container.
2019-11-23 19:57:39 +00:00
### Docker for production
2019-11-28 19:27:49 +00:00
You can use our official Docker image from [https://hub.docker.com/r/chatwoot/chatwoot ](https://hub.docker.com/r/chatwoot/chatwoot )
```bash
docker pull chatwoot/chatwoot
```
You can create an image yourselves by running the following command on the root directory.
2019-11-23 19:57:39 +00:00
```bash
2020-04-30 16:02:34 +00:00
docker-compose -f docker-compose.production.yaml build
2019-11-23 19:57:39 +00:00
```
2019-11-23 20:31:13 +00:00
This will build the image which you can depoy in Kubernetes (GCP, Openshift, AWS, Azure or anywhere), Amazon ECS or Docker Swarm. You can tag this image and push this image to docker registry of your choice.
2019-11-23 19:57:39 +00:00
Remember to make the required environment variables available during the deployment.