The guide describes how to use the KForge Web interface.
If you have a question that isn’t answered here please join the KForge mailing list and post your question there.
In the KForge Web interface and without being logged in, go to the sign up page (Home >> Sign up).
Fill in login details and submit the form.
The account will be created immediately.
In the Kforge Web interface and without being logged in, go to the login page (Home >> Login).
Fill in login details for your account and submit the form.
You will be logged in immediately, unless the details are incorrect.
In case login details have been forgotten, go to the login page (Home >> Login) and click the “Forgotten your password?” link.
Identify your account with either your username or your email address.
If your account can be idefitied, a new password will be sent to your email address.
When logged in, go to the logout page (Home >> Logout).
You will be logged out immediately.
When logged in, go to your profile page and click ‘Settings’ in the navigation bar or in the yellow sidebar box (Profile >> Settings).
Adjust personal details and press the ‘Change details’ button. Or change password and press the ‘Change password’ button. The account will be updated immediately.
You can also delete the account from the settings page (see below).
Please note, ticket functionality is only available if KForge’s trac plugin has been enabled.
When logged in, go to your profile page and select the ‘Tickets’ link from the navigation bar or the yellow sidebar box.
All the tickets you own or have reported will be listed.
To search for tickets across all projects, enter a search term in the ‘Search terms...’ box, and press the ‘Search’ button. Any matching tickets will be presented.
Please note, Trac search functionality is only available if KForge’s trac plugin has been enabled.
When logged in, go to your profile page and select the ‘Tracs’ link from the navigation bar or the ‘Search trac services’ link in the yellow sidebar box.
Enter a search term in the ‘Search terms...’ box, select or deselect the resources (e.g. changesets and wiki) that you don’t want to search, and press the ‘Search’ button.
All the resources that match within projects you have joined will be listed.
Please note, SSH functionality is only available if KForge’s ssh plugin has been enabled.
When logged in, go to your SSH keys page (Profile >> SSH).
Paste an SSH public key into the key string field. Submit the form.
The SSH key will be registered immediately.
Please note, SSH functionality is only available if KForge’s ssh plugin has been enabled.
When logged in, go to your SSH keys page (Profile >> SSH).
Any SSH keys that have been registered will be listed.
Please note, SSH functionality is only available if KForge’s ssh plugin has been enabled.
View your SSH keys (Profile >> SSH). Next to each key is a button to remove the key from the account.
Press the button to remove the key from the account.
Confirm that the key should be deleted.
The key will be deleted immediately.
When logged in, go to your API page (Profile >> API).
Your API key will be presented, along with a link to the API, and advice on how to authenticate requests using your API key.
When logged in, go to the project registration page (Projects >> New).
Fill in the details of the project and submit the form.
The project will be registered immediately, and you will be immediately added as an administrator of the project.
Go to the project register (Projects).
Either browse through the index (Projects >> Index) or search by entering search terms (Projects >> Search).
Select a project. You will be taken to the project detail page.
Please note, only project administrators can update project settings.
When logged in, find a project that you administrate.
Click the ‘Settings’ link in the navigation bar, or in the yellow sidebar box. You will be taken to the project settings page.
Adjust the project title, description, licenses, or change whether or not the project is hidden. Press the ‘submit changes’ button. Project settings will be updated immediately.
You can also delete the project from the settings page (see below).
Please note, only project administrators can create project services.
Please note, project services can be created only for plugins which are enabled. For example, if the Subversion plugin is enabled, then it will be possible to create Subversion services. Plugins are available for Subversion, Mercurial, Git, Trac, Wordpress, MoinMoin, etc.
View services for a project you administer. Press the ‘Add service’ button.
Complete and submit the ‘Add service’ form.
The service will be created immediately. Information about accessing the service will be presented on the new service page.
Find a project. Go to the services page.
The services of the project are listed in a table.
View services for a project. Each service has a small ‘service info’ link. Following that link will lead to the service help and status page, which displays specific information (and links) for accessing the service, along with more general information about the service’s functionality.
View services for a project. Select a service. You will be taken directly to the service.
Please note, only project administrators can update project services.
When logged in, view project services.
From the ‘Actions’ column, click the edit icon for a service.
Adjust the service and submit the form. For example, if you wish to associate a repository with a Trac service, then edit the Trac service and select the repository from the multi-select box.
The service will be updated immediately.
Please note, only project administrators can delete project services.
When logged in, view project services.
From the ‘Actions’ column, click the icon for removing a service.
Confirm that service should be deleted.
The service will be deleted immediately.
Please note, only project administrators can create project members.
When logged in, find a project. Press the ‘Add member’ button.
Complete and submit the ‘Add member’ form. Please note, friends will be able to read project services. Developers will be able to read and contribute to project services. Administrators will be able to create and remove project services, create and remove project members, and they will be able to delete the project.
The member will be created immediately.
Registered users can also apply to join projects. Project administrators will receive notification by email, and approve or reject membership requests.
Please note, by default unauthenticated visitors do not have permission to access project services. To allow visitors to access project services, simply add the Visitor person as a Friend of the project.
When logged in, find a project that you have not already joined.
Press the ‘Request membership’ button.
A request to join the project will be sent to the project administrators, who will either approve or decline the request. You will be notified by email.
Please note, only project administrators can approve pending project members.
When logged in, view project members.
Any pending requests will be displayed in a table below the table of members.
Click the icon to approve the member.
Select a role for the new member, and submit the form.
The member will be activated immediately.
Find a project. Go to the members page.
The members of the project are listed in a table.
When logged in, go to your profile page (Profile).
Your project memberships will be listed under the heading ‘Project memberships’.
Please note, only project administrators can update project members.
When logged in, view project members.
From the ‘Actions’ column, click the edit icon for a member.
Adjust the role and submit the form.
The member will be updated immediately.
Please note, only project administrators can delete project members.
When logged in, view project members.
From the ‘Actions’ column, click the icon for removing a member.
Confirm that member should be deleted.
The member will be deleted immediately.
When logged in, view your memberships.
From the ‘Actions’ column, click the icon for leaving a project.
Confirm that the membership should be deleted.
The membership will be deleted immediately.
Find a project that you administrate, and click the ‘Settings’ link.
Press the ‘Delete this project’ button.
Confirm that the project should be deleted.
The project will be deleted immediately.
When logged in, go to your profile settings page (Profile >> Settings).
Press the ‘Delete account’ button.
Confirm that the account should be deleted.
The account will be deleted immediately.