Portal:Toolforge

Please start with our Wikimedia Cloud Services Introduction and the Getting Started guide.

Toolforge

• Cloud Services overview
• Toolforge user docs
• Toolforge changelog

Get started

• Quickstart: set up and get access
• How Toolforge works
• Rules you must follow
• Tutorials

Build and run tools

• Navigate tool accounts and files
• Build container images for tools
• Run a web service
• Schedule and manage jobs
• Manage tool runtime configuration (envvars)
• Language-specific details:
  • Python
  • Pywikibot
  • Node.js
  • PHP
  • ...more languages/frameworks
• Use Redis for caching
• Index content with Elasticsearch

Access shared storage and databases

• Access shared storage and public wiki dumps
• Access the Wiki Replicas databases
• Access replica search indices
• Manage tool databases

Share and maintain tools

• Set up version control and code review
• Develop successful tools
• Find and share tools on Toolhub
• Delete a tool
• Contribute to Toolforge

Get help

• How and where to get help
• Troubleshooting

Useful links

• Toolforge admin docs
• List of tools
• Toolforge Admin Console (toolsadmin)

[]

Tool Labs (or Tools) is a hosting environment for developers working on services that provide value to the Wikimedia and Wiki ecosystem. These services allow developers to easily do adhoc analytics, administer bots, run webservices, and generally create tools to help editors and other volunteers in their work. The environment also includes access to a variety of data services.

The Tool Labs community-developed web applications are all listed at tools.wmflabs.org. There is also a smaller selection listed in more detail at Hay's Tools Directory.

Becoming a Tools Lab developer

See also: Getting started and Access

1. Use the Tool Labs admin console to create a new LDAP account.
   • Make careful note of the LDAP username and UNIX shell username you choose
     • Your LDAP username and password will be used to login here on Wikitech and on Gerrit and the Tool Labs admin console.
     • Your shell name will be used when you interact with servers via ssh and when using git with Gerrit.
2. Fill out an access request to join the Tools project.
3. Generate an SSH key that you will use along with your shell account name to log into the Tool Labs servers if you do not already have one.
4. Associate your SSH public key with your Wikitech account using the Preferences > OpenStack tab or Tool Labs admin console.
5. Wait for your access request for the Tools project to be processed (you should receive messages on your Wikitech talk page).