QuickStart Guide
Your probably have one already.
If not, we can recommend solutions for both
OS X and
Windows.
This is just a simple form.
Choose your domain name, confirm your e-mail address and you're all set.
Pagekite.py is a very small, quick download.
You'll need
Python 2.x, but
many operating systems come with it pre-installed.
Read on for details ...
Step 1: Install a web server
Before using PageKite, you will need a web server. The HowTo has some recommendations:
Once your web server is up and running, verify that it works on your local network and take note of which port it is listening on: if it is not the default (port 80), then you will need to modify your PageKite configuration in step 3.
Step 2: Get a PageKite account
Depending on how you found this document, you may already have one!
If not, you can sign up here. Just fill out the form, wait for the confirmation e-mail and follow its instructions to activate your account.
Each account comes with a moderate amount of free bandwidth and you can start using it right away.
Step 3: Install and run pagekite.py
[ Overview
| Windows
| Mac OS X
| Linux
]
Overview
- Install Python 2.x, if necessary.
- Download the program and a settings file from Your Account.
- Move the downloaded files to the correct location.
- Run pagekite.py!
(for more details, select your operating system above)
Mac OS X
- Log on to pagekite.net by clicking the "My Account" button.
- Download: pagekite.py and Mac OS X settings from the "My Account" page.
- Move pagekite.py to wherever you prefer. We like:
sudo mv pagekite.py /usr/local/bin/
- Move pagekite.rc (the settings file) to:
/Users/YOURNAME/.pagekite.rc
- In a terminal, make the program executable:
chmod +x /path/to/pagekite.py
- Run pagekite.py.
Linux
- Log on to pagekite.net by clicking the "My Account" button.
- Download: pagekite.py and Linux settings from the "My Account" page.
- Move pagekite.py to wherever you prefer. We like:
sudo mv pagekite.py /usr/local/bin/
- Move pagekite.rc (the settings file) to:
~/.pagekite.rc
- In a terminal, make the program executable:
chmod +x /path/to/pagekite.py
- Run pagekite.py.
That's it!
- Your website should now be visible to the wider Internet, using the domain name
you chose when you signed up.
- If your web server does not run on port 80, you will need to edit the settings
file using a simple text editor (such as WordPad or vim) before running
pagekite.py.
- To turn the program off, just close the window or press CTRL-C.
Step 4: Getting the most out of PageKite
At this point, you will have just scratched the surface of what you can do with PageKite:
- The default configuration enables a single web server on port 80, but you can in fact tunnel many web servers over a single PageKite connection, by adding kites on the Your Account page and either downloading a new configuration file or editing your current one.
- PageKite also supports HTTPS encrypted websites, SSH and VNC connections.
- An alternate method for installing PageKite on Linux machines is to try out the experimental Debian package.
- Using mobile phones with PageKite is still considered experimental, but Android users can find some hints in the wiki.
The how-to section of the wiki and the FAQ have more details.
Welcome to PageKite!