Oxygen XML Web Author with Git using Bitbucket

ann.jensen
Posts: 153

Oxygen XML Web Author with Git using Bitbucket

Mon Jan 09, 2017 2:59 pm

Hi,
I have an instance of our DITA source stored in Git accessible from an internal server hosting Bitbucket.
Can I use one of the Web Author plugins to connect to our Bitbucket server and access DITA content there?
Thanks in advance,
Ann
Gabriel Titerlea
Posts: 31

Re: Oxygen XML Web Author with Git using Bitbucket

Mon Jan 09, 2017 6:23 pm

Hi,

Yes, you can use Web Author to edit files located on a Bitbucket server. Web Author comes with a git plugin which allows one to open files from any git repository.

To edit a file stored in a git repository:
- click the Open/New Git buttons located on the Web Author Dashboard [1]
- type in your Bitbucket user & pass in the login dialog
- type in the URI of your bitbucket repository: "https://your_bitbucket_install/example_team/example_project"
- choose the branch on which you want to work
- click "Browse" and open a file for editing
- after editing, commit your file [2]

Note that if you use a self-signed SSL certificate for your BitBucket server you may need to enable the "Automatically accept a security certificate, even if invalid" option found under Connection in the administration page [3]

[1] https://www.oxygenxml.com/doc/versions/ ... =dashboard
[2] https://www.oxygenxml.com/doc/versions/ ... tml?hl=git
[3] https://www.oxygenxml.com/doc/versions/ ... l=security

Best,
Gabriel
ann.jensen
Posts: 153

Re: Oxygen XML Web Author with Git using Bitbucket

Mon Jan 09, 2017 6:55 pm

Hi Gabriel,
I mistyped my login credentials for Bitbucket but don't know how to get back the popup that allows me to type in my login credentials again.
Also, our Bitbucket is running on a private server so do I not need to type in the server URL somewhere?
Thanks,
Ann
Gabriel Titerlea
Posts: 31

Re: Oxygen XML Web Author with Git using Bitbucket

Tue Jan 10, 2017 10:53 am

Hi,

Sorry about that, it looks like there's a bug preventing the logout button from showing up.
I fixed the bug and updated the Git plugin. You can download the latest version from here [1] (webapp-github-plugin-18.1-plugin.jar) and replace the one you have using the admin page [2] (Delete the old one, upload the new one).

[1] https://github.com/oxygenxml/webapp-git ... tag/18.1.0
[2] https://www.oxygenxml.com/doc/versions/ ... e_a_plugin
[3] https://www.oxygenxml.com/doc/versions/ ... start.html

Best,
Gabriel
ann.jensen
Posts: 153

Re: Oxygen XML Web Author with Git using Bitbucket

Tue Jan 10, 2017 7:49 pm

Thanks for that. I have deleted and installed the updated plugin.
One other thing I still am not sure of: what am I being logged in to when I enter my username and password? Out Bitbucket is running on an internal server not on the cloud...so will this work?
thanks,
Ann
cristi_talau
Posts: 92

Re: Oxygen XML Web Author with Git using Bitbucket

Wed Jan 11, 2017 11:15 am

Hello,

The Git support works also with on-premise installations of BitBucket. When you open a file, make sure to specify the URL of your local BitBucket server, then enter your BitBucket credentials to enable Web Author open and commit files on your behalf.

Best,
Cristian
Gabriel Titerlea
Posts: 31

Re: Oxygen XML Web Author with Git using Bitbucket

Wed Jan 11, 2017 11:41 am

One other thing I still am not sure of: what am I being logged in to when I enter my username and password?

To clarify. You aren't being logged into anything actually. After you type in the username and password we store them, encrypted, for the current editing session. When a commit/read into/from a repository requires credentials we present the stored username and password.
ann.jensen
Posts: 153

Re: Oxygen XML Web Author with Git using Bitbucket

Thu Jan 12, 2017 12:38 pm

Ok, that's clearer to me now.

So I tried the following:
1. Select to open using Git.
2. Enter my username, password and associated email address (for our internal Bitbucket server).
3. Under Choose File, I pasted in the complete path to one of my Dita files viewable from the Bitbucket server i.e. http://<bitbucketservername>:7990/projects/ASPEN/repos/idocsprototype/browse/system_documentation/dita_files/c_introduction.dita

I then get the following failure message:
Failed opening repository : http://<bitbucketservername>:7990/projects/ASPEN/repos/idocsprototype/browse/system_documentation/dita_files/c_introduction.dita

I have double-checked my login credentials and they are correct for the Bitbucket server.
Any advice appreciated,
Regards,
Ann
Gabriel Titerlea
Posts: 31

Re: Oxygen XML Web Author with Git using Bitbucket

Thu Jan 12, 2017 2:52 pm

You should paste the repository URI, the URI you would use to clone a repository using git:

Code: Select all

git clone MY_REPO


Instead of the path to the specific file you want to open use MY_REPO.

Best,
Gabriel
ann.jensen
Posts: 153

Re: Oxygen XML Web Author with Git using Bitbucket

Thu Jan 12, 2017 6:54 pm

Oh Ok, my bad :-|
I am connected now.
Thanks for your help,
Ann
ann.jensen
Posts: 153

Re: Oxygen XML Web Author with Git using Bitbucket

Tue Feb 14, 2017 3:28 pm

Hi,
I have since had Oxygen XML Web Author installed on a central server and am trying to connect to my Git repo from it.
I have already successfully connected from my local install of Oxygen XML Web Author but am running into problems with server install.

To recap the steps required:
1. Launch Oxygen XML Web Author installation
2. Log in to Administration page and select checkbox beside Automatically accept a security certificate, even if invalid
3. Navigate to homepage i.e. app/oxygen.html
4. Select Open --> Git
5. Enter username and password for the Git repo
6. Paste in the repo URI e.g. http://username@servername:port/path/repo.git

I am getting the error

Code: Select all

Failed opening repository : http://username@servername:port/path/repo.git


Any advice appreciated,
Regards,
Ann
Gabriel Titerlea
Posts: 31

Re: Oxygen XML Web Author with Git using Bitbucket

Tue Feb 14, 2017 4:23 pm

Hi,

Try typing https://... instead of http://... for the repo URI.

If that does not work I need more information to fix the error. Please enable additional debug logging by appending:
log4j.category.com.oxygenxml.examples.git=debug

to the log-config file.

To locate the log-config file follow the first steps here [1].

After that you need to restart Web Author, go back to the Dashboard page and attempt to open a file. After you receive the error again, please find the oxygen.log file [1] and send it over to support@oxygenxml.com mentioning this forum post.

[1] https://www.oxygenxml.com/doc/versions/ ... ng%20files

Best,
Gabriel

Return to “DITA (Editing and Publishing DITA Content)”

Who is online

Users browsing this forum: No registered users and 1 guest