Skip to content

Commit 2cfde78

Browse files
committed
Improved README
1 parent 2254155 commit 2cfde78

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@ Then enable the new GitRemote SCM type in [http://redmine-root/settings?tab=repo
1616

1717
![](https://dl.dropbox.com/u/29440342/screenshots/AYKNZDTB-2014.11.27-15-59-06.png)
1818

19+
The plugin shells out to the following binaries, so make sure they're available:
20+
* git
21+
* ssh-keyscan
22+
* ssh-keygen
23+
1924
## Supporting private repos
2025

2126
For security sake, we don't support cloning over HTTPS with username password, but only via SSH.
@@ -77,7 +82,15 @@ cd /home/redmine/redmine && ./script/rails runner "Repository.fetch_changesets"
7782

7883
Notes:
7984

80-
* Tested on Redmine 2.6.
81-
* Currently alpha level, use at your own risk.
82-
* Currently insecure, only install if all redmine project admins are trusted.
83-
* This plugin doesn't clean-up (delete) cloned repos from the file system when the record is deleted from Redmine.
85+
* Tested on Redmine 2.6 and ruby 2.1
86+
* Currently alpha state, use at your own risk. Given possible security risks of shelling out,
87+
we recommend using this plugin only if all RedMine project admins are trusted users.
88+
* This plugin doesn't clean-up (delete) cloned repos from the file system when the record
89+
is deleted from Redmine.
90+
* Currently Redmine will crash if this plugin is uninstalled, as rails can't
91+
seem to handle model classes disappearing while db records reference them.
92+
This snippet should make the error go away:
93+
94+
```
95+
./script/rails runner 'ActiveRecord::Base.connection.execute("UPDATE repositories SET type=\"Repository::Git\" WHERE type = \"Repository::GitRemote\")' -e production
96+
```

0 commit comments

Comments
 (0)