Add a dockerignore and README instruction for Docker

This commit is contained in:
Travis Ralston 2018-07-20 18:29:28 -06:00
parent 66bbda6b8e
commit f6b05949e1
2 changed files with 89 additions and 0 deletions

76
.dockerignore Normal file
View File

@ -0,0 +1,76 @@
.idea/
node_modules/
web-dist/
logs/
config/development.yaml
config/production.yaml
db/*.db
start.sh
config/integrations/*_development.yaml
config/integrations/*_production.yaml
build/
dimension.db
src/**/*.js
src/**/*.js.map
web/**/*.js
web/**/*.js.map
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
# Runtime data
pids
*.pid
*.seed
*.pid.lock
# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# Coverage directory used by tools like istanbul
coverage
# nyc test coverage
.nyc_output
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt
# Bower dependency directory (https://bower.io/)
bower_components
# node-waf configuration
.lock-wscript
# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release
# Dependency directories
node_modules/
jspm_packages/
# Typescript v1 declaration files
typings/
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Optional REPL history
.node_repl_history
# Output of 'npm pack'
*.tgz
# Yarn Integrity file
.yarn-integrity
# dotenv environment variables file
.env

View File

@ -20,6 +20,17 @@ The remaining settings should be tailored for your Riot deployment. If you're se
# Running your own # Running your own
### Docker
To get started quickly, run the following command or build the Docker image:
```bash
docker run -p 8184:8184 -v /path/to/dimension/store:/data turt2live/matrix-dimension
```
In the `/path/to/dimension/store` make sure there is a file named `config.yaml`. This will be the configuration that Dimension uses.
### Compiling it yourself
Prerequisites: Prerequisites:
* [NodeJS](https://nodejs.org/en/download/) 8 * [NodeJS](https://nodejs.org/en/download/) 8
* npm 5 or higher (`npm install -g npm@latest`) * npm 5 or higher (`npm install -g npm@latest`)
@ -39,6 +50,8 @@ nano config/production.yaml
NODE_ENV=production npm run start:app NODE_ENV=production npm run start:app
``` ```
### Setting up Dimension
If you didn't change the port, Dimension should now be running on port 8184. It's best to set up your environment so that Dimension runs on a dedicated subdomain that *is not* the same as your Riot domain. This is to help keep Riot and Dimension safe and secure. If you didn't change the port, Dimension should now be running on port 8184. It's best to set up your environment so that Dimension runs on a dedicated subdomain that *is not* the same as your Riot domain. This is to help keep Riot and Dimension safe and secure.
In your Riot `config.json`, set the integration manager to be your Dimension URL. Replace `dimension.t2bot.io` in the example above (under "Configuring Riot to use Dimension") with your Dimension URLs. In your Riot `config.json`, set the integration manager to be your Dimension URL. Replace `dimension.t2bot.io` in the example above (under "Configuring Riot to use Dimension") with your Dimension URLs.