No Description

Girish M b77a9c060d removing dependencies of test and configure.sh 4 years ago
.github 8f98096317 Create FUNDING.yml 4 years ago
.vscode 10b1899713 adding docker file 4 years ago
resource a9aae03f27 updating demo with better quality gif 4 years ago
.dockerignore 10b1899713 adding docker file 4 years ago
.gitignore 2c1e515dc1 updated .gitignore and README 4 years ago
Dockerfile 10b1899713 adding docker file 4 years ago
LICENSE bbff1e37d4 Create LICENSE 4 years ago
README.md 9563c5d033 fix Markdown lint errors 4 years ago
configure.sh 6b9d353d69 Update package.json with start script and configure.sh with updated url 4 years ago
docker-compose.yml 68a629b0e1 #5 adding docker-compose and updated README.md 4 years ago
index.js f4154ae2d5 Issue: Post project selection #2 4 years ago
package-lock.json 6b9d353d69 Update package.json with start script and configure.sh with updated url 4 years ago
package.json b77a9c060d removing dependencies of test and configure.sh 4 years ago

README.md

op-mattermost

OpenProject and Mattermost integration to log time for a work package. This integration is built along the lines of op-slack-connector

Dependencies

  • OpenProject community edition
  • Mattermost preview
  • ngrok
  • docker
  • Node js and npm modules
    • express
    • axios
    • moment
    • dotenv
    • nodemon

Installing dependencies

  • Docker
  • OpenProject
    • Quick install
    • docker run -it -p 8080:80 -e SECRET_KEY_BASE=secret openproject/community:latest or
    • Recommended install
    • sudo mkdir -p /var/lib/openproject/{pgdata, static}
    • docker run -d -p 8080:80 --name openproject -e SECRET_KEY_BASE=secret \ -v /var/lib/openproject/pgdata:/var/openproject/pgdata \ -v /var/lib/openproject/static:/var/openproject/assets \ openproject/community:latest
    • docker stop openproject
    • docker start openproject
  • Mattermost
    • docker run --name mattermost-preview -d --publish 8065:8065 --add-host dockerhost:127.0.0.1 mattermost/mattermost-preview
  • ngrok
  • Node js

Setup and contribution guidelines

  • Same as described here.
    • Except for step 3 which invovles creation of .env file. Run sh configure.sh to create .env using command line. The entries in .env would contain following:
    • OP_URL=http://<your host or ip address>:8080/api/v3/ #needed for pointing to OpenProject installation
    • INT_URL=<ngrok url>/ #needed for exposing the integration running on port 3000
    • MM_URL=http://<your host or ip address>:8065/api/v4/ #needed for pointing to Mattermost installation
    • MATTERMOST_ACCESS_TOKEN=<personal access token> # https://docs.mattermost.com/developer/personal-access-tokens.html
    • MATTERMOST_SLASH_TOKEN=<use the mattermost slash command token> #needed for slash command validation
    • OP_ACCESS_TOKEN=<openproject access token obtained from profile page>
    • Step 7 shall be replaced with creation of Mattermost slash command as described here

Demo

Demo