Portal:Toolforge

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)

[]

Overview

Toolforge is a hosting environment that makes it easy for you to perform analytics, administer bots, run webservices, and create tools to help project editors, technical contributors, and other volunteers who are working on Wikimedia projects.

Toolforge is part of the Wikimedia Cloud Services (WMCS) suite of services. It is supported by Wikimedia Foundation staff and volunteers.

This page contains links to documentation for Tool developers, maintainers, and Toolforge administrators.

Toolforge quickstart

Ready to get started with Toolforge, right now? Follow these steps:

1. Create a Wikimedia developer account
2. Add an SSH public key
3. Request access to a Toolforge project/account
4. Create a new Tool

Toolforge documentation

Tool developer/maintainer documentation

• About Toolforge: What is Toolforge? What do you need to know to join the Toolforge community and start developing tools? Learn the basics!
• Toolforge Help: What is a Tool Account? How do you use it to build tools and make contributions to Wikimedia projects? Learn how to create and maintain tools with Tool Accounts following basic Toolforge workflows.

Toolforge admnistration documentation

• Toolforge administration documentation

Communication and support

Support and administration of the WMCS resources is provided by the Wikimedia Foundation Cloud Services team and Wikimedia movement volunteers. Please reach out with questions and join the conversation:

Discuss and receive general support

• Chat in real time in the IRC channel #wikimedia-cloud ^connect or the bridged Telegram group
• Discuss via email after you have subscribed to the cloud@ mailing list

Stay aware of critical changes and plans

• Subscribe to the cloud-announce@ mailing list (all messages are also mirrored to the cloud@ list)
• Read the News wiki page

Track work tasks and report bugs

Use a subproject of the #Cloud-Services Phabricator project to track confirmed bug reports and feature requests about the Cloud Services infrastructure itself

Read stories and WMCS blog posts

Read the Cloud Services Blog (for the broader Wikimedia movement, see the Wikimedia Technical Blog)