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)

[]

To create or deploy tools on Toolforge, you need a Wikimedia Developer Account.

Overview

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

Toolforge quickstart

Ready to get started with Toolforge? Check out the Toolforge quickstart guide.

Toolforge documentation

About Toolforge

• About Toolforge: What is Toolforge? What do you need to know to join the Toolforge community and start developing tools?
• At-a-glance: Cloud VPS and Toolforge: What are the main differences between Cloud VPS and Toolforge? Which environment should you choose?

Tool developer/maintainer documentation

Toolforge Help: Learn how to follow basic Toolforge workflows to create and maintain tools using Tool Accounts.

Toolforge administration documentation

Documentation for administrators of the Toolforge service itself can be found at Portal:Toolforge/Admin.

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)