|Version 10 (modified by travis-w, 5 years ago)|
Administrators of projects hosted on SourceForge.net have a multitude of tools available to help them maintin their project. These options are available under the Admin tab of the project listing.
While we encourage all project administrators to choose the permissions granted to developers very carefully (particularly the Project Administration permission), it is important that all active projects consider having at least two project administrators. This will help to ensure that at least one person is available to perform administrative operations for the development team, to respond to inquiries from third parties or from SourceForge.net staff, and that the interests of your project are represented even if one of the administrators becomes temporarily unavailable. Some of the highest risks to project data and integrity occur when projects have only one administrator, and that administrator becomes unavailable for a significant period of time.
Seeking skilled developers (and people who are interested in the goals of your project) is one of the most important activities performed by project administrators.
See: Help wanted?
The Public Info page is used to modify the descriptive name (i.e. the name that appears on your project pages), description (as seen on the Summary Page for this project), and Trove categorization for this project (as seen on the Summary Page for this project). Public project information is also shown in search results and within the Software Map.
It is the responsibility of all SourceForge.net-hosted projects to maintain their own backups of project data. To assist you in developing a suitable data archival plan for your project, we provide a full set of instructions and procedures for backing-up project data.
See: Backup your data
The XML Data Export 2.0 facility provides Tracker data, DocManager data, Forum posts and Project News releases in an XML format. Due to the limited visibility of data flagged as deleted (which will appear in this export), the XML Data Export may only be accessed by Project Administrators.
See: XML export
Ability to backup your CVS Repository is provided via read-only rsync access.
Subversion Repository backups are provided via read-only rsync access.
The audit trail facility contains a list of all key (administrative) events in your project's history, including the username of the person who made the changes, the date/time the change occurred, and a description of the change.
One of the common tasks between both developers and project administrators is spreading the word about your project. SourceForge.net provides a project news system, several site pages and RSS feeds to help promote your project.
File Releases: New projects should strive to make their first File Release as early as possible, as to give potential developers and users something they can collaborate to improve. "Release early, release often"
This page provides a listing of the current project settings and the data provided regarding this project at time of registration. The information shown to the general public may be managed from the Public Info section of the Project Admin pages.
Since the information on this page was provided at time of project registration, it is important to note that the project description and license details may have changed (particularly if control of this project space has been transferred to a different project effort) since time of initial registration.
SourceForge.net has strict policies regarding the removal of project data. These policies exist because SourceForge.net is designed not just as a place for active Open Source software development to occur, but also as a way to preserve the software developed as that it will not be lost when active development ceases.
See: Removing a project
If you wish to takeover the administration of a project, you may request the takeover of that project. Takeover of orphaned projects (those without administrators) will be processed in a matter of a couple business days. Takeover of projects that have an administrator will take a couple of weeks, as we need to contact the administrator for confirmation that they are no longer actively working on the project. Prior notice of takeover is provided both by email to the existing project administrator(s) and via the My SF.net page.
All admins must opt in before you can begin receiving donations. Fees accessed against donations are explained in the site documentation.
The Hosted Apps offering has been designed as a companion to our Project Web offering. Project Web is designed to be a very open-ended offering, permitting a wide array of use by projects. While it is possible to host third party applications in project web space, certain limitations of the shared hosting environment we provide as the project web service will hinder ease of deployment. The Hosted Apps offering is designed to be very easy to enable, providing immediate availability of popular application features to your projects and reducing the application maintenance burden on projects.
See: Hosted Apps
The project Screenshot feature is an important publicity tool, allowing potential end-users to preview your software. The Screenshot feature is accessed using the "Screenshots" link in the project navbar. Each project can post images of their software in action, highlighting features they believe most interest their end-users.
Project Web, Shell and Database Services
SourceForge.net provides all hosted projects the ability to store project-related web content on its servers. This service offering (project web service) has a number of complimentary services. Project shell services are provided to permit management and generation of project web content. Project database services are provided to allow projects to have more complex web sites (many content management systems can use a database backend). SourceForge.net also provides a VHOST (Virtual Host) service, which allows our web servers to answer traffic for a domain that you register.
Acceptable Use: As with all SourceForge.net project services, it is up to your project team to decide which of our services you wish to use. Certain restrictions apply to usage of the project web, shell and database services; these restrictions have been established to ensure each project hosted on SourceForge.net receives a fair portion of our resources, to prevent resource abuse, and to ensure resources are focused toward our primary goal (supporting the collaborative development of Open Source software). If your project is unable to comply with these usage restrictions, you should seek hosting for your project web site elsewhere -- information on how to change the Home Page link for your project may be found at the bottom of this page.
Project web services:
- Project web services may only be used for housing content directly related to the project (personal home pages and other non-project materials are not permitted).
- Project web services may be used to provide project-related information, documentation and development information.
- Your project web site must display the SourceForge.net logo, as described below.
- You may not use your project web site to provide a service to the general community (such as a playable game, or forum unrelated to your software development effort).
- You may not use your project web site to generate revenue, display advertisements or information about non-Open Source products, or to solicit donations except via the SourceForge.net Donation System.
- File releases may not be made available via your project web space (unless you have received permission in writing from SourceForge.net staff). File releases should be made available using the File Release System.
Project shell services:
- Project web services are provided solely for maintaining and generating project web content.
- Restrictions on the types of software which can be used on the project shell servers are documented in our Guide to Shell Services.
Security: SourceForge.net project web services are provided using a shared environment (all web pages and CGI scripts are served using a single user account on the project web servers). As result, there are some specific security implications that your project should be aware of; these are documented in our document titled, "Security and Risk Management for SourceForge.net Users and Projects". It should also be noted that it is the responsibility of your project to maintain its own data backups (which should include your project web content and project database content); additional information is provided for planning purposes in our Data Backup and Restoration Policy. Quota: Each project hosted on SourceForge.net is provided up to 100 megabytes of space for housing project-related material in their project web space, as accessible from the project shell server. File releases may not be stored in project web space -- they must be released via the File Release System. Data stored in your project database does not count toward this quota. If you believe your project requires more than 100 megabytes of disk for project web content, please submit a Support Request asking for an increased quota. Shell Service: To permit the management and generation of project web content, SourceForge.net provides all developers access (files may be transferred using SCP, SFTP or rsync over SSH) to the project shell server. Refer to Project Web, Shell, VHOST and Database Services for details on managing web content via SCP, SFTP, or rsync over SSH. Database Service: Each project hosted on SourceForge.net may opt-in for a MySQL database. Your project database may be used for software testing (provided it is not resource-intensive), or in managing project web content (i.e. as a backend for a content management system). Project databases may be managed by project administrators.
- Manage Project Databases
- Access this project's databases over the Internet
- Documentation: Guide to MySQL Database Services
VHOST Service: Many projects choose to register a domain name (this costs money -- you need to pay a domain name registrar when registering a domain name) for their project (i.e. thisismyproject.org). In order for the SourceForge.net project web servers to answer traffic for that domain, you will need to configure the DNS for that domain (with your DNS service provider -- SourceForge.net does not provide DNS service) and configure a VHOST (Virtual Host) on SourceForge.net. Project VHOSTs may be managed by project administrators.
- Manage VHOSTs
- Documentation: VHOST Services
SF.net Logo Display: All SourceForge.net projects that use the SourceForge.net project web services are required to display the SourceForge.net logo on all web pages, per the Project Web, Shell and Database Services site document. Details on how to display the logo for this project can be found on the Displaying the SourceForge.net Logo page. Donation Button Display: If your project has opted in to receive donations, you may display the "Support This Project" button on the project's web pages which links through to the donation page on SourceForge.net, enabling viewers to donate to your project quickly and easily.
To place the button on your pages, use the following HTML: <a href="http://sourceforge.net/donate/index.php?group_id=52614"><img src="http://images.sourceforge.net/images/project-support.jpg" width="88" height="32" border="0" alt="Support This Project" /> </a> HTML/RSS Feeds of Donor Information HTML and RSS feeds of recent project donors are available for projects that have opted-in to receive donations, allowing you to easily include this information on your project web site. Documentation:
- Guide to Project Web Services
- Instructions for Displaying the SourceForge.net Logo
- VHOST Services
- Guide to MySQL Database Services
- Project Shell Server Information
Permissions: All developers on your project are provided access to the project web server. All developers are provided access to write to directories within your group directory structure (i.e. those with group ownership of 'macgpg' and group write permission). Files must be readable by 'other' (i.e. chmod o+r filename) to be accessible to a CGI script." Please review our provided documentation for additional information about file permissions requirements. URL to Project Home Page: If your project is going to use the web services provided by SourceForge.net, you do not need to change this setting from its default ( sitedocs.sourceforge.net). However, if your project is hosting its web site elsewhere, update this field to provide the correct URL to that site. Changing this URL will change the destination of the "Home Page" link on your SourceForge.net project pages. Changes to this URL may only be made by project administrators. Project Home Page URL: http://
If your project home page is not hosted with SourceForge.net, we encourage you to set up a simple redirect within your project web space (so people going to http://sitedocs.sourceforge.net/ will not get a blank page or old content. To set up a simple redirect, create an index.php file on shell.sourceforge.net in the /home/groups/s/si/sitedocs/htdocs/ which contains (replace www.example.com with the correct URL): <?php header("Location: http://www.example.com/"); exit; ?> Outages: Notification of planned outages, scheduled upgrades and known issues affecting services covered on this page is provided in the Project web, Shell, MySQL and VHOST sections of the SourceForge.net Site Status page.
When managing any project, keeping track of various types of user-submitted issues and data can be quite a challenge. To help manage this problem, SourceForge.net provides its Tracker facility. By default, all projects are provided a Support Request Tracker, Bug Reporting Tracker, Patch Manager Tracker and Feature Request Tracker -- all use the Tracker facility to manage various types of issues and data.
Enable Trackers? Trackers (i.e. Support Requests, Feature Requests, Bug Reports, and those Trackers created by your project) may not be deleted, but can be removed from public view. You may remove a Tracker from use by following these instructions. Tracker Admin:
- Tracker Administration
- Tracker Reporting
Permissions: Use the Members page to designate developers as Tracker Technicians (who can be assigned Tracker items), Administrators (who can manage the settings of all Tracker items), or Admin and Tech (who can be assigned Tracker items and manage Tracker item settings). The Admin, Tech, and Admin/Tech permissions are granted on a per-Tracker basis. Developers given the Tracker Manager permission may perform administrative operations in all Trackers for the project.
When developing software, communication is vital. To aid in your efforts to communicate within your development team and for your developers to effectively communicate with your end-users, SourceForge.net provides projects the ability to establish mailing lists (email-based) and discussion forums (web-based). For management of support issues, bugs, patches and feature requests, we also provide the Tracker system.
Enable Mailing Lists? The following box should be checked to enable Mailing Lists: Enable Discussion Forums? The following box should be checked to enable Discussion Forums: Mailing List Admin: Mailing Lists are managed in two places. The creation of mailing lists is handled from the Mailing List Admin page on the SourceForge.net site. Mailing lists may be created by Project Admins. Once created, mailing lists cannot be removed (flagging the list as deleted merely removes it from the listing of available mailing lists, but does not shut down the mailing list -- contact the SourceForge.net team by submitting a Support Request for further assistance).
Once a list has been created, it is configured using the Mailman mailing list management software (which SourceForge.net uses to provide its mailing list service). Access to manage a mailing list via Mailman is provided using a separate admin password for each list -- this password does not match your SourceForge.net user password; there is only one admin password for each list, regardless of how many people administrate that list.
At time of list creation, a default password is sent to the list creator via email. If this password is lost, it may be reset via the Administer/Update Lists page for your project.
- Manage Mailing Lists
- Links to the Mailman list administration interface for each list may be found here.
Mailing List Archives: Archives are maintained on SourceForge.net for all hosted mailing lists. No mechanism is provided to remove posts from a mailing list archive. You may limit access to the archives for a mailing list by flagging that list as non-public on the SourceForge.net mailing list management page. Mailing list archives may be obtained in mbox format by contacting the SourceForge.net team by submitting a Support Request (raw list archives are not accessible for anti-spam/abuse reasons). Discussion Forum Admin: Discussion Forums are an integrated part of the SourceForge.net site.
[Manage Discussion Forums] Documentation:
- Instructions for managing mailing list subscriptions (as a subscriber)
Forums: Non-public discussion forums are accessible by all project developers. Developers not listed as Project Administrators may be provided access to remove postings from discussion forums. Use the Members page to designate developers as Forum Moderators. Forum Moderators may remove postings from all discussion forums for the project.
Mailing Lists: Mailing list access may be restricted using the features of the Mailman mailing list software. Mailing list administration is performed using the Mailing List Admin interface for the list in question; each mailing list has a separate list admin password, which will not be the same as your SourceForge.net user password (see the Mailing List Admin section, above). Outages: Notification of planned outages, scheduled upgrades and known issues affecting project mailing list services is provided in the Mailing List section of the SourceForge.net Site Status page.
Subversion (SVN) is a tool which allows development teams to safely coordinate and track software source code changes. SourceForge.net offers a Subversion services to all its projects, or you can link to a third party service. Enable Subversion:
The following box should be checked to enable Subversion:
Availability of Subversion data will not be affected by this setting. If you have data in your project Subversion repository and this service is disabled, Subversion operations may still be performed; however, the "Subversion" menu option on your project page will not be displayed. Select Subversion Resource:
Hosted Resource (Active) Non-SF.net Resource
https://sitedocs.svn.sourceforge.net Path to Repository:
/svnroot/sitedocs Access Instructions:
Information about accessing this Subversion repository may be found in our document titled "Subversion (Version Control for Source Code)". Migration Instructions:
You may migrate your CVS repository over to Subversion. Please refer to the Site Documentation on the topic. Other types of migration available, too. Documentation:
A significant amount of documentation is provided regarding project Subversion services. We encourage you to review the full set of documentation provided in the Site Documentation collection.
The following documents may be of immediate use:
- Documentation: Subversion usage instructions
- Instructions for installing and configuring a variety of Subversion clients may be found in the Site Documentation collection
There is no hard quota for the Subversion service. We do ask that projects exercise their best judgement and limit Subversion usage to data directly related to their project's development efforts. Permissions:
Read access: Your project SVN repository is automatically available via anonymous access. All site users are permitted to access your repository in this manner; no means is provided to restrict this read access. Instructions for accessing your repository anonymously may be found on the Subversion page for your project.
Write access: A permissions option is now provided to totally block developer repository access (when blocked, developers need to use anonymous access to the repository). Outages:
Subversion outages will be listed on the Site Status page. Hooks:
Information on hook script usage and implementation can be found in the Site Documentation
CVS (Concurrent Versions System) is a tool used by many software developers to manage changes within their source code tree. CVS provides the means to store not only the current version of a piece of source code, but a record of all changes (and who made those changes) that have occurred to that source code. Use of CVS is particularly common on projects with multiple developers, since CVS ensures changes made by one developer are not accidentally removed when another developer posts their changes to the source tree.
Enable CVS? The following box should be checked to enable CVS:
Availability of CVS data will not be affected by this setting. If you have data in your project CVS repository and this service is disabled, CVS operations may still be performed; however, the "CVS" menu option on your project page will not be displayed. CVS Server: sitedocs.cvs.sourceforge.net Path to Repository: /cvsroot/sitedocs Access Instructions: Project developers (and admins) must use :ext: authentication with SSH in order to obtain write access to the repository. Non-developers must use anonymous pserver-based authentication to access the repository.
Documentation: CVS usage instructions Documentation: A significant amount of documentation is provided regarding project CVS services. We encourage you to review the full set of documentation provided in the Site Documentation collection.
The following documents may be of immediate use:
- Documentation: CVS usage instructions
- Instructions for installing and configuring a variety of CVS clients may be found in the Site Documentation collection
Quotas: There are no quota limitations on use of your project CVS repository. Only project-related material (and normally only source code and documentation) may be stored in your project CVS repository. Read-Only Rsync: Read-only rsync access to the project's CVS repository is provided, allowing your project to backup its content. For access and usage information, refer to the CVS site documentation. Permissions: Read access: Your project CVS repository is automatically available via anonymous pserver-based CVS access. All site users are permitted to access your repository in this manner; no means is provided to restrict this read access. Instructions for accessing your repository via anonymous pserver may be found on the CVS page for your project. Write access: All project developers are automatically provided write access to your project CVS repository. As of 2004-06-10, a permissions option is now provided to totally block developer repository access (when blocked, developers need to use anonymous pserver for read access to the repository). You may restrict developer write access to a subset of your repository (modules, branches) through the use of CVS ACLs (the cvs_acls script). Data Removal: For security reasons, direct access to your project CVS repository is not provided. In the event that you need modules, directories, or files to be renamed, moved, removed, edited or otherwise manipulated, please contact the SourceForge.net team for assistance. Security Issues: In the event that sensitive materials (i.e. passwords, shared keys, etc.) are accidentally committed to your project CVS repository, please follow the provided instructions for handling this type of issue. Outages: Notification of planned outages, scheduled upgrades and known issues affecting project CVS services is provided in the CVS section of the SourceForge.net Site Status page.
SourceForge.net provides project administrators with a file release system for the purpose of managing project file downloads. The types of files and the content of the files you can publish are bound by the Terms of Service. For more information please see the Help documentation.
SourceForge.net provides a simple mechanism for storing HTML documentation generated by your project, the DocManager facility. DocManager permits online editing of documentation, storing of documentation for the general public or for internal project use, and allows you to easily maintain translated versions of your document in the same centralized location.
Enable DocManager? The following box should be checked to enable DocManager: DocManager Admin: Documentation may be submitted from any site user. Before the documentation will be visible publicly, a Project Administrator or DocManager Editor will need to change the status of the document from Pending to Active.
- Submit New Documentation
- Manage Pending/Active Documents
- Manage All Documents (Pending/Active/Deleted/Hidden/Private)
- Manage Document Groups
Multimedia Data: Since SourceForge.net pages may be accessed with or without SSL, images included in those pages must also be available both with and without SSL (otherwise users accessing the page may receive security warnings). To permit you to serve images from the documents you have placed in DocManager, SourceForge.net provides a facility to serve project-provided images. Each project may store up to one megabyte of multimedia data (bitmap and vector graphics, sound clips, 3D models).
[Edit Multimedia Data] Automation: SourceForge.net provides a tool, adocman, to automate all DocManager operations (anything possible via the web interface may be performed using our command-line tool). adocman may be used from any platform that supports perl. The adocman suite provides a number of tools for automating (from the command-line) SourceForge.net operations which require authentication. Currently, DocManager operations and the retrieval of data from the XML export facility are supported. adocman is available for download from the 'sitedocs' project on SourceForge.net. Permissions: All SourceForge.net site users are permitted to submit documentation to a project (they need not be listed as a developer on your project). Developers not listed as Project Administrators may be provided access to maintain content within DocManager. Use the Members page to designate developers as DocManager Editors. DocManager Editors may perform all DocManager operations (approve content for display, remove content, change document content and settings).
Task manager Among the site features offered to projects on SourceForge.net is the Task Manager tool. Your project may use the Task Manager to track outstanding tasks, establishing due dates and assigning tasks to specific members of your team.
Enable Task Manager? The following box should be checked to enable Task Manager: Enable Task Dependency List? The following box should be checked to enable task dependencies: Task Manager Mailings: If desired, you may provide email addresses to which all an email-based notification of all new task assignments will be sent. If this is not desired, simply leave the next field blank. Mail assignments to:
The following box should be checked if you wish for mail to be sent on all updates (not just new task assignments): Task Manager Admin:
- Configure Task Manager
- Task Manager Reporting
Permissions: Use the Members page to designate developers as Task Manager Technicians (who can be assigned tasks), Administrators (who can manage task settings of all tasks), or Admin and Tech (who can be assigned tasks and manage task settings).
Wikispaces Wikis provide a tool for managing unstructured, linkable content. Wiki content is a combination of plain text, markup for page formatting such as bold or italics, headers, bulleted and numbered lists, and linked content.
Project statistics SourceForge.net provides a variety of statistics about the usage of your project resources. These statistics may be used by your project to help identify growth trends and to identify potential problems in your support and development processes.
Project Statistics: SourceForge.net provides general statistics about the activity of this project on the Project Statistics page. The Project Statistics page is accessible by the general public. Tracker Reporting: Tracker administrators may make use of the Reporting facility to collect statistical information about the types of issues handled by the project, resolutions used to close issues, the lifespan of issues, and the distribution of issues among the developers within your team. These reports may be generated from the Tracker Reporting page. These reports may be accessed only by those developers flagged as Tracker Admins from the Members section of the Project Admin pages. Task System Reporting: Projects making use of the Task Manager system may generate reports related to the aging of tasks, the distribution of tasks within the project team and by subproject. These reports may be generated from the Task Manager Reporting page. These reports may be accessed only by those developers flagged as Task Managers from the Members section of the Project Admin pages. Outages: Notification of planned outages, scheduled upgrades and known issues affecting project statistics is provided in the Statistics section of the SourceForge.net Site Status page.