Using (Fast)CGI for non-PHP websites - Revision history

Milanmeu: /* Python and Django */

2025-01-07T00:16:54Z

Python and Django

← Older revision		Revision as of 02:16, 7 January 2025
Line 136:		Line 136:
	This guide was based on, and you can find more information in the official Django documentation:		This guide was based on, and you can find more information in the official Django documentation:
	* [https://docs.djangoproject.com/en/stable/intro/tutorial01/ The Django tutorial]		* [https://docs.djangoproject.com/en/stable/intro/tutorial01/ The Django tutorial]
	* [https://flask.palletsprojects.com/en/1.1.x/deploying/fastcgi/ Flask documentation for FastCGI]		* [https://web.archive.org/web/20220811150710/https://flask.palletsprojects.com/en/2.0.x/deploying/fastcgi/ Flask documentation for FastCGI]

	==== Go ====		==== Go ====

Bert: /* CGI */

2024-04-14T22:53:16Z

CGI

← Older revision		Revision as of 00:53, 15 April 2024
Line 13:		Line 13:

	Here's an example of a very simple Python CGI script (called <code>hello.cgi</code>):		Here's an example of a very simple Python CGI script (called <code>hello.cgi</code>):
	<pre>#!/usr/bin/env ~~python~~		<pre>#!/usr/bin/env python3

	print 'Content-Type: text/plain\n'		print('Content-Type: text/plain\n')
	print 'Hello world!'</pre>		print('Hello world!')</pre>

	CGI scripts need to be executable, otherwise they won't work:		CGI scripts need to be executable, otherwise they won't work:

Thomasd: /* Python and Django */

2023-09-11T19:13:17Z

Python and Django

← Older revision		Revision as of 21:13, 11 September 2023
Line 83:		Line 83:
	ALLOWED_HOSTS = [ 'username.ulyssis.be', 'username.studentenweb.org' ]		ALLOWED_HOSTS = [ 'username.ulyssis.be', 'username.studentenweb.org' ]
	</pre>		</pre>
			Use your ULYSSIS username in place of ''username''.
	</li>		</li>
	<li>		<li>

Thomasd: /* Python and Django */

2023-09-11T19:11:52Z

Python and Django

← Older revision		Revision as of 21:11, 11 September 2023
Line 70:		Line 70:
	</li>		</li>
	<li>		<li>
	Install Django inside of this virtualenv:		Install Django and flup for FastCGI inside of this virtualenv:
	<pre>pip install django</pre>		<pre>pip install django flup6</pre>
	</li>		</li>
	<li>		<li>
	Create a new Django project:		Create a new Django project:
	<pre>django-admin~~.py~~ startproject mysite</pre>		<pre>django-admin startproject mysite</pre>
	Replace ''mysite'' with your project's desired name.		Replace ''mysite'' with your project's desired name.
	</li>		</li>
	<li>		<li>
	~~Install flup~~ for ~~FastCGI~~:		Edit the allowed hosts in your Django project's settings, in <code>mysite/mysite/settings.py</code>. Look for the line <code>ALLOWED_HOSTS = []</code> and replace it with:
	<pre>~~pip install flup6~~</pre>		<pre>
			ALLOWED_HOSTS = [ 'username.ulyssis.be', 'username.studentenweb.org' ]
			</pre>
	</li>		</li>
	<li>		<li>

Bert: /* Go */

2021-07-19T23:58:16Z

← Older revision		Revision as of 01:58, 20 July 2021
Line 200:		Line 200:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
	If you want to give this example a try, save it as <code>mysite.fcgi.go</code> and then use <code>go build</code> to compile it.		If you want to give this example a try, save it as <code>mysite.fcgi.go</code> and then use <code>go build mysite.fcgi.go</code> to compile it.
	</li>		</li>
	<li>Visit your website to verify everything works</li>		<li>Visit your website to verify everything works</li>

Bert: /* Restarting your application */

2021-07-19T23:55:03Z

Restarting your application

← Older revision		Revision as of 01:55, 20 July 2021
Line 52:		Line 52:
	If you've changed your application, you will need to restart it for these changes to take effect. However, because you're editing the application on a different server than where it is running, you do not have access to the running process. You'll have to create some sort of mechanism to restart the process.		If you've changed your application, you will need to restart it for these changes to take effect. However, because you're editing the application on a different server than where it is running, you do not have access to the running process. You'll have to create some sort of mechanism to restart the process.

	In the Django ~~example~~ below, the starter script has been written so that when it is changed, the application is automatically restarted within 1 second. The same mechanism can be applied to other Python sites. You can change the modification date without actually changing the contents of the starter script by using <code>touch</code>:		In the Django and Go examples below, the starter script has been written so that when it is changed, the application is automatically restarted within 1 second. The same mechanism can be applied to other Python sites. You can change the modification date without actually changing the contents of the starter script by using <code>touch</code>:
	<pre>touch starter.fcgi</pre>		<pre>touch starter.fcgi</pre>
	Replace <code>starter.fcgi</code> with the name of your starter script.		Replace <code>starter.fcgi</code> with the name of your starter script.

Pcy: more uniform inline code snippet/keyword style, "that's called" -> "which is called"

2021-04-28T22:20:03Z

more uniform inline code snippet/keyword style, "that's called" -> "which is called"

← Older revision		Revision as of 00:20, 29 April 2021
Line 8:		Line 8:
	in general we recommend you to use a framework together with FastCGI. There are many frameworks, ranging from very simple and lightweight, to more complex and feature rich.		in general we recommend you to use a framework together with FastCGI. There are many frameworks, ranging from very simple and lightweight, to more complex and feature rich.

	If, for example, you want Apache to interpret all files with the extension <tt>.cgi</tt> as CGI scripts, use the following <tt>.htaccess</tt> file (to be placed in your <tt>www</tt> folder):		If, for example, you want Apache to interpret all files with the extension <code>.cgi</code> as CGI scripts, use the following <tt>.htaccess</tt> file (to be placed in your <code>www</code> folder):
	<pre>Options +ExecCGI		<pre>Options +ExecCGI
	AddHandler cgi-script .cgi</pre>		AddHandler cgi-script .cgi</pre>

	Here's an example of a very simple Python CGI script (called <tt>hello.cgi</tt>):		Here's an example of a very simple Python CGI script (called <code>hello.cgi</code>):
	<pre>#!/usr/bin/env python		<pre>#!/usr/bin/env python

Line 27:		Line 27:
	In order to use FastCGI, you will generally need a starter script specific to your programming languae, framework or application. Just do a web search for "''keyword'' mod_fcgid", where ''keyword'' is the programming language, framework or application you're planning to use, and you will often find good instructions. We've included some examples below		In order to use FastCGI, you will generally need a starter script specific to your programming languae, framework or application. Just do a web search for "''keyword'' mod_fcgid", where ''keyword'' is the programming language, framework or application you're planning to use, and you will often find good instructions. We've included some examples below

	You'll want to treat this starter script as a <tt>mod_fcgid</tt> script, and usually, you'll want to redirect everything to this script, so you can use an <tt>.htaccess</tt> file that looks like this:		You'll want to treat this starter script as a <code>mod_fcgid</code> script, and usually, you'll want to redirect everything to this script, so you can use an <code>.htaccess</code> file that looks like this:
	<syntaxhighlight lang="apache">Options +ExecCGI		<syntaxhighlight lang="apache">Options +ExecCGI
	AddHandler fcgid-script .fcgi		AddHandler fcgid-script .fcgi
Line 35:		Line 35:
	Replace ''starter.fcgi'' with the name of your starter script. Don't forget to make your starter script executable:		Replace ''starter.fcgi'' with the name of your starter script. Don't forget to make your starter script executable:
	<pre>chmod +x starter.fcgi</pre>		<pre>chmod +x starter.fcgi</pre>
	The starter script must be located in the same folder as the <tt>.htaccess</tt> file.		The starter script must be located in the same folder as the <code>.htaccess</code> file.

	{{warning\|Warning!\|Do not place sensitive files inside the web accessible folder. Make sure they are located in a folder outside the document root, or they will be downloadable through the webserver.}}		{{warning\|Warning!\|Do not place sensitive files inside the web accessible folder. Make sure they are located in a folder outside the document root, or they will be downloadable through the webserver.}}
	It is adviced to only place the fcgi starter script, <tt>.htaccess</tt> and static files (images, stylesheets) inside the document root.		It is adviced to only place the fcgi starter script, <code>.htaccess</code> and static files (images, stylesheets) inside the document root.

	=== Startup time and persistency ===		=== Startup time and persistency ===
Line 52:		Line 52:
	If you've changed your application, you will need to restart it for these changes to take effect. However, because you're editing the application on a different server than where it is running, you do not have access to the running process. You'll have to create some sort of mechanism to restart the process.		If you've changed your application, you will need to restart it for these changes to take effect. However, because you're editing the application on a different server than where it is running, you do not have access to the running process. You'll have to create some sort of mechanism to restart the process.

	In the Django example below, the starter script has been written so that when it is changed, the application is automatically restarted within 1 second. The same mechanism can be applied to other Python sites. You can change the modification date without actually changing the contents of the starter script by using <tt>touch</tt>:		In the Django example below, the starter script has been written so that when it is changed, the application is automatically restarted within 1 second. The same mechanism can be applied to other Python sites. You can change the modification date without actually changing the contents of the starter script by using <code>touch</code>:
	<pre>touch starter.fcgi</pre>		<pre>touch starter.fcgi</pre>
	Replace ''starter.fcgi'' with the name of your starter script.		Replace <code>starter.fcgi</code> with the name of your starter script.

	=== Examples ===		=== Examples ===
Line 63:		Line 63:
	<ol>		<ol>
	<li>[[Accessing shell servers over SSH\|Log in to a shell server]]</li>		<li>[[Accessing shell servers over SSH\|Log in to a shell server]]</li>
	<li>Create a new virtualenv, you can create one in <tt>~/.venv</tt>, for example:		<li>Create a new virtualenv, you can create one in <code>~/.venv</code>, for example:
	<pre>python3 -m venv ~/.venv</pre>		<pre>python3 -m venv ~/.venv</pre>
	</li>		</li>
Line 83:		Line 83:
	</li>		</li>
	<li>		<li>
	Put an <tt>.htaccess</tt> file in your site's directory, e.g. the <tt>www</tt> folder:		Put an <code>.htaccess</code> file in your site's directory, e.g. the <code>www</code> folder:
	<pre>Options +ExecCGI		<pre>Options +ExecCGI
	AddHandler fcgid-script .fcgi		AddHandler fcgid-script .fcgi
Line 91:		Line 91:
	</li>		</li>
	<li>		<li>
	Create the starter script (replace ''user'' with org if you are an organization, and ''username'' with your ULYSSIS username):		Create the starter script (replace <code>user</code> with org if you are an organization, and <code>username</code> with your ULYSSIS username):
	<syntaxhighlight lang="python">#!/home/user/username/.venv/bin/python		<syntaxhighlight lang="python">#!/home/user/username/.venv/bin/python

Line 120:		Line 120:
	WSGIServer(get_internal_wsgi_application(), debug=False).run()		WSGIServer(get_internal_wsgi_application(), debug=False).run()
	</syntaxhighlight>		</syntaxhighlight>
	Call this script <tt>mysite.fcgi</tt>.		Call this script <code>mysite.fcgi</code>.
	</li>		</li>
	<li>		<li>
Line 140:		Line 140:
	<ol>		<ol>
	<li> [[Accessing shell servers over SSH\|Log in to a shell server]]</li>		<li> [[Accessing shell servers over SSH\|Log in to a shell server]]</li>
	<li> Put an .htaccess file in your site's directory (e.g. the www folder) with a reference to your executable. Here we've chosen mysite.fcgi, but you can adapt this to your liking.		<li> Put an <code>.htaccess</code> file in your site's directory (e.g. the <code>www</code> folder) with a reference to your executable. Here we've chosen <code>mysite.fcgi</code>, but you can adapt this to your liking.
	<pre>Options +ExecCGI		<pre>Options +ExecCGI
	AddHandler fcgid-script .fcgi		AddHandler fcgid-script .fcgi
Line 147:		Line 147:
	RewriteRule ^(.*)$ mysite.fcgi/$1 [QSA,L]</pre>		RewriteRule ^(.*)$ mysite.fcgi/$1 [QSA,L]</pre>
	</li>		</li>
	<li> Write your code and compile the binary to mysite.fcgi. Below you can find a basic example of how to register two handlers (of which one is the fallback), then start the FastCGI client, and finally have a function (~~that's~~ called as a goroutine) to check if the binary has been replaced so old processes don't stick around.		<li> Write your code, and compile the binary to <code>mysite.fcgi</code>. Below you can find a basic example of how to register two handlers (of which one is the fallback), then start the FastCGI client, and finally have a function (which is called as a goroutine) to check if the binary has been replaced so old processes don't stick around.
	<syntaxhighlight lang="go">package main		<syntaxhighlight lang="go">package main

Line 200:		Line 200:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
	If you want to give this example a try, save it as mysite.fcgi.go and then use go build to compile it.		If you want to give this example a try, save it as <code>mysite.fcgi.go</code> and then use <code>go build</code> to compile it.
	</li>		</li>
	<li>Visit your website to verify everything works</li>		<li>Visit your website to verify everything works</li>

Bert: /* Go */

2021-04-28T01:41:07Z

← Older revision		Revision as of 03:41, 28 April 2021
Line 136:		Line 136:

	==== Go ====		==== Go ====
			To make a website or web application in Go and host it on your ULYSSIS hosting account, you can use the standard library ''fcgi'' package.

			<ol>
			<li> [[Accessing shell servers over SSH\|Log in to a shell server]]</li>
			<li> Put an .htaccess file in your site's directory (e.g. the www folder) with a reference to your executable. Here we've chosen mysite.fcgi, but you can adapt this to your liking.
			<pre>Options +ExecCGI
			AddHandler fcgid-script .fcgi
			RewriteEngine On
			RewriteCond %{REQUEST_FILENAME} !-f
			RewriteRule ^(.*)$ mysite.fcgi/$1 [QSA,L]</pre>
			</li>
			<li> Write your code and compile the binary to mysite.fcgi. Below you can find a basic example of how to register two handlers (of which one is the fallback), then start the FastCGI client, and finally have a function (that's called as a goroutine) to check if the binary has been replaced so old processes don't stick around.
			<syntaxhighlight lang="go">package main

			import (
			"fmt"
			"net/http"
			"net/http/fcgi"
			"os"
			"path/filepath"
			"time"
			)

			func uri_interesting(w http.ResponseWriter, r *http.Request) {
			w.WriteHeader(http.StatusOK)
			fmt.Fprintln(w, "<h1>Oh, seems like this link isn't that interesting after all</h1>")
			fmt.Fprintln(w, "<p>Back to the <a href=\"/\">Homepage</a></p>")
			}

			func uri_default(w http.ResponseWriter, r *http.Request) {
			if r.URL.Path != "/" {
			w.WriteHeader(http.StatusNotFound)
			fmt.Fprintln(w, "<h1>This page doesn't exist</h1>")
			fmt.Fprintln(w, "<p>Back to the <a href=\"/\">Homepage</a></p>")
			} else {
			w.WriteHeader(http.StatusOK)
			fmt.Fprintln(w, "<h1>Welcome to this testwebsite!</h1>")
			fmt.Fprintln(w, "<p>This website is written in Go but doesn't really do much.")
			fmt.Fprintln(w, "Feel free to visit this <a href=\"/interesting/link\">Interesting link</a> or this <a href=\"/non-existent/link\">non-existent link</a>.</p>")
			}
			}

			func main() {
			go check_selfreplacement()
			http.HandleFunc("/interesting/link", uri_interesting)
			http.HandleFunc("/", uri_default)
			if err := fcgi.Serve(nil, nil); err != nil {
			panic(err)
			}
			}

			func check_selfreplacement() {
			fcgi_location, _ := os.Executable()
			fcgi_location, _ = filepath.EvalSymlinks(fcgi_location)
			start_stat, _ := os.Stat(fcgi_location)
			for {
			current_stat, _ := os.Stat(fcgi_location)
			if start_stat.ModTime() != current_stat.ModTime() {
			os.Exit(0)
			}
			time.Sleep(1 * time.Second)
			}
			}
			</syntaxhighlight>
			If you want to give this example a try, save it as mysite.fcgi.go and then use go build to compile it.
			</li>
			<li>Visit your website to verify everything works</li>
			</ol>

	[[Category:Webserver]]		[[Category:Webserver]]

Bert: /* Examples */

2021-04-27T15:50:59Z

Examples

← Older revision		Revision as of 17:50, 27 April 2021
Line 134:		Line 134:
	* [https://docs.djangoproject.com/en/stable/intro/tutorial01/ The Django tutorial]		* [https://docs.djangoproject.com/en/stable/intro/tutorial01/ The Django tutorial]
	* [https://flask.palletsprojects.com/en/1.1.x/deploying/fastcgi/ Flask documentation for FastCGI]		* [https://flask.palletsprojects.com/en/1.1.x/deploying/fastcgi/ Flask documentation for FastCGI]

			==== Go ====

	[[Category:Webserver]]		[[Category:Webserver]]

Bert: /* Python and Django */

2021-04-27T10:25:48Z

Python and Django

← Older revision		Revision as of 12:25, 27 April 2021
Line 59:		Line 59:
	==== Python and Django ====		==== Python and Django ====

	If you want to make a website using [https://www.djangoproject.com/ Django], we recommend that you use a virtual environment. You can use the following steps to get up and running with Django on your ULYSSIS hosting account.		If you want to make a website using Python and [https://www.djangoproject.com/ Django], we recommend that you use a virtual environment. You can use the following steps to get up and running with Django on your ULYSSIS hosting account.

	<ol>		<ol>