From Wikitech
Jump to navigation Jump to search


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 log out and then log in 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.

Run new tool - Quickstart

As soon as you get SSH access to bastion and call "become MY_TOOL", you get in the /data/project/MY_TOOL directory. This is your tool's $HOME.

  1. Create your tool's code/html root dir: mkdir public_html
  2. Create your tool's code:
    • echo '<html><head></head><body>Hello!<?php ?></body></html>' > public_html/index.php
  3. Start the tool: webservice start
  4. Navigate to https://MY_TOOL.toolforge.org/ in your web browser and it should show something.

This is just an example of creation a simple PHP tool. For more details about this and other kinds of tools see Help:Toolforge/Web and Help:Toolforge/How to.

Manage existing tool - Quickstart

As soon as you get SSH access to bastion and call "become MY_TOOL", you get in the /data/project/MY_TOOL directory. This is your tool's $HOME. Then you can:

  1. Edit tool software and config files which are placed usually in any of $HOME/public_html, $HOME/www/python, $HOME/www/js, $HOME/public_tomcat, etc. For editing you can use console text editors (vi, edit, mcedit, etc.) or you can download/edit/upload files using SCP/SFTP protocol.
  2. Check if the tool is running and also its type (php/python/js/java/etc.) and selected backend (kubernetes/grid) using command: webservice status.
  3. Stop the tool: webservice stop
  4. Start the tool again: webservice --backend=kubernetes TYPE_OF_YOUR_TOOL start
  5. SSH to the tool's container: webservice --backend=kubernetes TYPE_OF_YOUR_TOOL shell

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
Cloud Services Blog Clouds & Unicorns Learning more details about some of our work
Wikimedia Technology Blog techblog.wikimedia.org News and stories from the Wikimedia technical movement

See Also