|
1 month ago | |
---|---|---|
.github | 1 year ago | |
.idea | 4 years ago | |
resource | 1 year ago | |
test | 2 years ago | |
.dockerignore | 4 years ago | |
.gitignore | 2 years ago | |
.npmrc | 2 years ago | |
CONTRIBUTING.md | 1 year ago | |
COPYING | 4 years ago | |
Dockerfile | 2 years ago | |
Procfile | 4 years ago | |
README.md | 2 months ago | |
configure.sh | 2 years ago | |
docker-compose.yml | 2 years ago | |
index.js | 2 years ago | |
package-lock.json | 2 months ago | |
package.json | 1 month ago | |
wait_for_it.sh | 4 years ago |
OpenProject integration for Mattermost. Currently, supports following operations using a slash command -
recorded using Peek.
docker run -it -p 8080:80 -e SECRET_KEY_BASE=secret openproject/community:11
orsudo 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:11
docker stop openproject
docker start openproject
docker run --name mattermost-preview -d --publish 8065:8065 --add-host dockerhost:127.0.0.1 mattermost/mattermost-preview
npm install
to install npm dependenciesgit clone
the repo using HTTPSsh configure.sh
to create .env
using bash command line. Alternatively, create a .env
file using a text editor with the following entries:
OP_URL=http://<your host or ip address>:8080/api/v3/
(needed for pointing to OpenProject installation)INT_URL=http://<your host or ip address>:3000/
(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_SLASH_TOKEN=<use the mattermost slash command token for logtime>
/op
as described here and provide localhost or IP address (with port 3000) as the request URL and method as POST
MATTERMOST_BOT_TOKEN=<use the mattermost bot access token>
(needed for validation for posting messages as bot)
OP_ACCESS_TOKEN=<openproject access token (a.k.a apikey) obtained from user account page>
npm init
to generate (or update existing) package.json
filenpm install
to download and install the node modules from npmnpm start
(usually launches on port 3000)billable hours
for all work packages in a project/op
in the message bar./op
command:
AllowedUntrustedInternalConnections
for the integration thenSystem Console
of MattermostAllow untrusted internal connections to
/op
- Displays the general menu/op lt
- Log time for a work package/op cwp
- Create a work package for a project/op tl
- View time logs of the current user/op dwp
- Delete work package/op dtl
- Delete time log entry/op sub
- Subscribe to OpenProject notifications in Mattermost channelDevelopment wiki is available here. It contains the workflows, file description and miscellaneous information necessary for development.
A Mattermost plugin with limited features mentioned in this project is available here.
This project is also available on following repositories (as an alternative to GitHub) on:
This project was sponsored by OpenProject Foundation (OPF) and mentioned in OpenProject integrations.
Copyright (C) 2019 to present, Girish M
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.