Go to file
Johannes Frohnmeyer 60fee1c071
Add additional details on deployment
2022-10-25 17:11:47 +02:00
src/main More fixes, should work now 2022-10-22 23:55:55 +02:00
.gitignore Untested initial impl 2022-10-22 21:36:37 +02:00
LICENSE Add additional details on deployment 2022-10-25 17:11:47 +02:00
README.md Add additional details on deployment 2022-10-25 17:11:47 +02:00
build.gradle.kts Add additional details on deployment 2022-10-25 17:11:47 +02:00
settings.gradle.kts Untested initial impl 2022-10-22 21:36:37 +02:00

README.md

Gitea-Helpdesk

Gitea-Helpdesk is an extension to Gitea that allows users to create issues through emails, comment on existing ones and receiving notifications for new comments. To do so, it must be connected to a postgresql database, a gitea instance and a mail server (pop3+smtp). The mail server MUST support sub-addressing with + and the repository name and gitea username must match [a-zA-Z0-9-_]+. To set up the service, build a jar and add a config file as follows to the current directory:

{
  "gitea": {
    "host": "https://gitea.example.com", // Your gitea instance 
    "token": "0123456789abcdef0123456789abcdef12345678" // An access token
  },
  "email": {
    "address": "helpdesk@example.com", // The e-mail address of the help desk
    "waitTime": 10, // The amount of seconds to wait between each iteration
    "smtp": {
      "host": "smtp.example.com:465", // The address of the SMTP server
      "password": "1234", // The password for login (the username is the address)
      "ssl": true // Whether to enable ssl encryption
    },
    "pop3": {
      "host": "pop3.example.com:995", // The address of the POP3 server
      "password": "1234", // The password for login (the username is the address)
      "ssl": true // Whether to enable ssl encryption
    }
  },
  "database": {
    "connectionString": "postgresql://localhost/helpdesk?user=helpdesk" // The postgresql connection string (see postgresql jdbc documentation, sockets are supported)
  },
  "web": {
    "port": 80, // The port to host the website at
    "publicAddress": "http://127.0.0.1:80" // Where users will access the website
  }
}

It is also recommended to replace the template file repo/issue/list.tmpl (as described here) with one that contains a link to the helpdesk. As an example, my own service uses the following line:

<a class="ui green button" href="https://helpdesk.frohnmeyer-wds.de/issue?repo={{.Repository.Name}}&owner={{.Repository.Owner.Name}}">Helpdesk</a>****

added next to the one with repo.issues.new