Portal:Toolforge/Quickstart

Toolforge
Toolforge technical documentation Toolforge administrator documentation Help and communication List of tools Terms and conditions Glossary Technical documentation resources
Getting started Cloud VPS and Toolforge at a glance 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 Mono/.NET tools and bots Develop tools in Java Develop tools in Python Develop tools using Pywikibot framework Web servers for tools (Kubernetes) Grid engine
Additional documentation Version control in Toolforge Elasticsearch for Toolforge Redis for Toolforge Dumps and Toolforge Database

Overview

This page covers the basic steps to getting started with Toolforge.

For more information and links to developer/maintainer documentation visit the Toolforge Portal.

Getting started with Toolforge - Quickstart

1. Create a Wikimedia developer account.
2. Create an SSH key and add it to your Wikitech account.
3. Submit a Toolforge project membership request and wait for its approval.
   • Your request will be reviewed, and you will receive confirmation within a week. You will be notified through your Wikitech user account.
4. Once you are added as a Toolforge member, you must logout and then login again at https://toolsadmin.wikimedia.org/
   • Doing this is required for your membership to take effect.
5. Create a new tool or join an existing Tool account
6. Access the Toolforge project and manage files in Toolforge.

Communication and support

We communicate and provide support through several primary channels. Please reach out with questions and to join the conversation.

Communicate with us

	Connect	Best for
Phabricator Workboard	#Cloud-Services	Task tracking and bug reporting
IRC Channel	#wikimedia-cloud connect	General discussion and support
Mailing List	cloud@	Information about ongoing initiatives, general discussion and support
Announcement emails	cloud-announce@	Information about critical changes (all messages mirrored to cloud@)
News wiki page	News	Information about major near-term plans
Blog	Clouds & Unicorns	Learning more details about some of our work

See Also

• Portal:Toolforge
• Help:Toolforge