Portal:Toolforge/Quickstart
| Toolforge |
|---|
 |
|
|
|
|
|
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
- Create a Wikimedia developer account.
- Create an SSH key and add it to your Wikitech account.
- 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.
- 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.
- Create a new tool or join an existing Tool account
- Access the Toolforge project and manage files in Toolforge.
Run new tool - Quickstart
As soon as you log in to username@login.toolforge.org (via ssh) and call "become MY_TOOL", you get in the /data/project/MY_TOOL directory. This is your tool's $HOME.
- Create your tool's code/html root dir:
mkdir public_html - Create your tool's code:
echo '<html><head></head><body>Hello world!<?php ?></body></html>' > public_html/index.php
- Start the tool:
webservice start - Navigate to https://MY_TOOL.toolforge.org/ in your web browser and it should show something.
This is just an example that creates a simple PHP tool. For more details about this (and other kinds of tools), see Help:Toolforge/Web and Help:Toolforge/How to. For troubleshooting, see Help:Troubleshooting Toolforge.
Manage existing tool - Quickstart
As soon as you log in to login.toolforge.org (via ssh) and call "become MY_TOOL", you get in the /data/project/MY_TOOL directory. This is your tool's $HOME. Then you can:
- 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.), use a version control tool like Git or you can download/edit/upload files using SCP/SFTP protocol. - Check if the tool is running and also its type (php/python/js/java/etc.) and selected backend (kubernetes/grid) using command:
webservice status. - Stop the tool:
webservice stop - Start the tool again:
webservice --backend=kubernetes TYPE_OF_YOUR_TOOL start - 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.
| Way | Connect | Best for |
|---|---|---|
| Phabricator Workboard | #Cloud-Services | Task tracking and bug reporting |
| IRC Channel | #wikimedia-cloud connect Telegram bridge mattermost bridge |
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 Technical Blog | techblog.wikimedia.org | News and stories from the Wikimedia technical movement |