Help:Toolforge/How to

Toolforge

<inputbox> type=fulltext prefix="Help:Tool" searchbuttonlabel= Search placeholder=Search Toolforge Documentation width=35 break=no </inputbox>

• Toolforge technical documentation
• Toolforge administrator documentation
• Help and communication
• List of tools
• Terms and conditions
• Rules
• Glossary
• Technical documentation resources

Getting started

• Cloud Services, Cloud VPS, and Toolforge overview
• About Toolforge
• Toolforge quickstart guide
• How-tos, tutorials and walkthroughs
• Create a Wikimedia developer account
• Access Toolforge instances with PuTTY and WinSCP
• Troubleshooting Toolforge

Developing tools

• Tool accounts
• Developing successful tools
• Develop tools in Java
• Develop tools in Mono/.NET
• Develop tools in Python
• Develop tools using Pywikibot framework
• Develop tools in Rust
• Web servers for tools
• Jobs framework
• Raw Kubernetes jobs (using API)

Backends

• Kubernetes (default)
• Grid engine (Deprecated, Don't use)

Additional documentation

• Version control in Toolforge
• Elasticsearch for Toolforge
• Redis for Toolforge
• Dumps and Toolforge
• Database
• Contributing

[]

Overview

This page contains links to Toolforge tutorials and developer experiences.

Tutorials

Python

More about Toolforge and support for Python

Libraries

• toolforge Python helper library and usage by Legoktm
• Using pywikibot on Labs by Russell Blau

flask

• Python flask application stub with OAuth support
  • A detailed tutorial on setting up a Python 3 flask webservice running on Kubernetes and using OAuth for authentication.

Django

• Python Django application stub with OAuth support
  • A detailed tutorial on setting up a Python 3 Django webservice running on Kubernetes and using OAuth for authentication.

Node.js

• Node.js application with stub OAuth support
  • A detailed tutorial on setting up a node.js express webservice running on Kubernetes and using OAuth for authentication.

PuTTY and WinSCP

• How to access Toolforge instances with PuTTY and WinSCP

GitHub

• How to set up automatic updates from a GitHub repository
  • Step-by-step instructions for setting up a tool to be automatic updated whenever its GitHub repository is pushed to.

Developer stories

• Personal experiences migrating from Toolserver to Toolforge by Magnus Manske
• Speeding up Toolforge Tools with Redis by Legoktm

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, the bridged Telegram group, or the bridged Mattermost channel
• Discuss via email after you subscribed to the cloud@ mailing list

Receive mail announcements about critical changes

Subscribe to the cloud-announce@ mailing list (all messages are also mirrored to the cloud@ list)

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

Learn about major near-term plans

Read the News wiki page

Read news and stories about Wikimedia Cloud Services

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