ULYSSIS documentation - User contributions [en]

Overview

2024-08-24T20:31:32Z

Pcy: /* Webserver */

<div style="background:#f9f9f9;border:1px solid #ddd;font-size:95%;padding:1.5em;">
Welcome to our documentation website. Many of the common procedures and issues our users experience are described here. If you still encounter problems we haven't covered or you just can't seem to get things to work, even though you followed one of our manuals, feel free to contact us on ulyssis@ulyssis.org for personal support.</div>

<div>
<div style="width:45%;float:left;padding-right:10px;">
== Account ==
* [[Registering a new account]]
* [[Renewing your account]]
* [[Transferring your account]]
* [[Resetting your password]]
* [[Reducing disk usage|Help, my account uses too much disk space]]
* [[Why do I have to pay 0.00 euro and how?]]
</div><div style="width:45%;float:left">
== Files ==
* [[Accessing your files]]
* [[Transferring files over SFTP]]
* [[Making Backups]]
* [[Secure file permissions]]
* [[Reducing disk usage]]
</div>
<div style="clear:both;"></div>
</div>

<div>
<div style="width:45%;float:left;padding-right:10px;">

== Webserver ==
* [[Webserver changes summer 2024]]
* [[Using your webspace]]
* [[Using (Fast)CGI for non-PHP websites]]
* [[Getting Apache logs]]
* [[Managing PHP errors]]
* [[Setting PHP options]]
* [[Sending email from websites]]
* [[Adding domain names|Adding domain names (.be, .com, .org, ...)]]
* [[Getting SSL/TLS|Getting SSL/TLS (HTTPS security)]]
* [[Shibboleth|Shibboleth (Centrale KU Leuven Login)]]
* [[Claiming a port]]
* [[ULYSSIS security measures]]
</div><div style="width:45%;float:left">

== Mail ==
* [[Introduction to ULYSSIS email]]
* [[Mailbox]]
* [[Mailbox in Thunderbird]]
* [[Forwarders]]
* [[Using a forwarder as an alias]]
* [[Add an alias in Gmail]]
* [[Add an alias in Hotmail/Outlook]]
* [[Add an alias in Thunderbird]]
* [[Add an alias in ULYSSIS webmail]]
* [[Spam]]
* [[ULYSSIS security measures]]
</div>
<div style="clear:both;"></div>
</div>

<div>
<div style="width:45%;float:left;padding-right:10px;">

== CMSs ==
* [[Software Version Checker]]
* [[Setting up WordPress]]
* [[Setting up Drupal]]
* [[Setting up Joomla]]
* [[Setting up MediaWiki]]
* [[Updating WordPress]]
* [[Updating MediaWiki]]
</div><div style="width:45%;float:left">

== Security & anti-spam ==
* [[Secure file permissions]]
* [[Software Version Checker]]
* [[Preventing spam on Wordpress]]
* [[Preventing spam on Joomla]]
* [[Preventing spam on Drupal]]
* [[Preventing spam on MediaWiki]]
* [[Securing MediaWiki using Centrale KU Leuven Login]]
* [[ULYSSIS security measures]]
</div>
<div style="clear:both;"></div>
</div>

<div>
<div style="width:45%;float:left;padding-right:10px;">

== Databases ==
* [[Using PostgreSQL]]
* [[Using MySQL]]
* [[Using PHPMyAdmin]]
* [[Using PHPPgAdmin]]
* [[Using Adminer]]
* [[Making Backups]]

</div><div style="width:45%;float:left">

== Shell ==
* [[Accessing your files]]
* [[Transferring files over SFTP]]
* [[Accessing shell servers over SSH]]
* [[ULYSSIS public IRC]]
* [[Useful Linux Commands]]
* [[Managing Cron jobs]]
* [[Claiming a port]]
* [[Installing packages]]
</div>
<div style="clear:both;"></div>
</div>

<div>
<div style="width:45%;float:left;padding-right:10px;">

== Versioning ==
* [[GitLab]]
</div><div style="width:45%;float:left">

== ULYSSIS Public Services ==
* [[ULYSSIS public IRC]]
</div>
<div style="clear:both;"></div>

<div>
<div style="width:45%;float:left;padding-right:10px;">
== Tutorials ==
* [[Using the kulemt package]]
* [[Exporting your KU Leuven class schedule and calendar]]
</div>
<div style="clear:both;"></div>
</div>

__NOTOC__

Webserver changes summer 2024

2024-08-05T20:56:05Z

Pcy: /* When are the changes planned? */

This page lists the changes to the webservers of ULYSSIS in the summer of 2024, and how you can prepare for it. If any of these
instructions are not clear to you, or if you have some more questions about the changes, '''don't hesitate to e-mail us at [mailto:ulyssis@ulyssis.org ulyssis@ulyssis.org]'''.

== When are the changes planned? ==

These changes are planned to be applied on Sunday 8 and Monday 9 september, 2024.

== What will change? ==

We will upgrade the Ubuntu release on our servers from 22.04 LTS to 24.04 LTS. This will include newer version of many services. An overview of the most important version changes can be found below. For other services/packages, you can always use the [https://packages.ubuntu.com/ Ubuntu Package Search]. The distribution name for Ubuntu 24.04 LTS is "noble".

* PHP will be updated from 8.1 to 8.3
* PostgreSQL will be updated from 14 to 16.2
* MariaDB (MySQL) will be updated from 10.6.7 to 10.11.8
* Python will be updated from 3.10 to 3.12

Furthermore, many services (such as Apache2) are migrating their regex engine from PCRE to PCRE2. You can find a list of incompatibilities [https://stackoverflow.com/questions/70273084/regex-differences-between-pcre-and-pcre2 here].

If you host your own PHP website, you might want to check out these guides:
* [https://www.php.net/manual/en/migration82.php Migrating from PHP 8.1.x to PHP 8.2.x]
* [https://www.php.net/manual/en/migration83.php Migrating from PHP 8.2.x to PHP 8.3.x]

Note that any existing Python virtual environments in use will need to be recreated in order to function properly.

Webserver changes summer 2024

2024-08-05T20:55:53Z

Pcy: /* When are the changes planned? */

This page lists the changes to the webservers of ULYSSIS in the summer of 2024, and how you can prepare for it. If any of these
instructions are not clear to you, or if you have some more questions about the changes, '''don't hesitate to e-mail us at [mailto:ulyssis@ulyssis.org ulyssis@ulyssis.org]'''.

== When are the changes planned? ==

These changes are planned to be applied on 8 and 9 september, 2024.

== What will change? ==

We will upgrade the Ubuntu release on our servers from 22.04 LTS to 24.04 LTS. This will include newer version of many services. An overview of the most important version changes can be found below. For other services/packages, you can always use the [https://packages.ubuntu.com/ Ubuntu Package Search]. The distribution name for Ubuntu 24.04 LTS is "noble".

* PHP will be updated from 8.1 to 8.3
* PostgreSQL will be updated from 14 to 16.2
* MariaDB (MySQL) will be updated from 10.6.7 to 10.11.8
* Python will be updated from 3.10 to 3.12

Furthermore, many services (such as Apache2) are migrating their regex engine from PCRE to PCRE2. You can find a list of incompatibilities [https://stackoverflow.com/questions/70273084/regex-differences-between-pcre-and-pcre2 here].

If you host your own PHP website, you might want to check out these guides:
* [https://www.php.net/manual/en/migration82.php Migrating from PHP 8.1.x to PHP 8.2.x]
* [https://www.php.net/manual/en/migration83.php Migrating from PHP 8.2.x to PHP 8.3.x]

Note that any existing Python virtual environments in use will need to be recreated in order to function properly.

Webserver changes summer 2024

2024-07-07T15:58:42Z

Pcy: Created page with "This page lists the changes to the webservers of ULYSSIS in the summer of 2024, and how you can prepare for it. If any of these instructions are not clear to you, or if you have some more questions about the changes, '''don't hesitate to e-mail us at [mailto:ulyssis@ulyssis.org ulyssis@ulyssis.org]'''. == When are the changes planned? == These changes are planned in the weekend of <TBC>. == What will change? == We will upgrade the Ubuntu release on our servers from 2..."

This page lists the changes to the webservers of ULYSSIS in the summer of 2024, and how you can prepare for it. If any of these
instructions are not clear to you, or if you have some more questions about the changes, '''don't hesitate to e-mail us at [mailto:ulyssis@ulyssis.org ulyssis@ulyssis.org]'''.

== When are the changes planned? ==

These changes are planned in the weekend of <TBC>.

== What will change? ==

We will upgrade the Ubuntu release on our servers from 22.04 LTS to 24.04 LTS. This will include newer version of many services. An overview of the most important version changes can be found below. For other services/packages, you can always use the [https://packages.ubuntu.com/ Ubuntu Package Search]. The distribution name for Ubuntu 24.04 LTS is "noble".

* PHP will be updated from 8.1 to 8.3
* PostgreSQL will be updated from 14 to 16.2
* MariaDB (MySQL) will be updated from 10.6.7 to 10.11.8
* Python will be updated from 3.10 to 3.12

Furthermore, many services (such as Apache2) are migrating their regex engine from PCRE to PCRE2. You can find a list of incompatibilities [https://stackoverflow.com/questions/70273084/regex-differences-between-pcre-and-pcre2 here].

If you host your own PHP website, you might want to check out these guides:
* [https://www.php.net/manual/en/migration82.php Migrating from PHP 8.1.x to PHP 8.2.x]
* [https://www.php.net/manual/en/migration83.php Migrating from PHP 8.2.x to PHP 8.3.x]

Note that any existing Python virtual environments in use will need to be recreated in order to function properly.

TEST Software Version Checker

2021-12-18T19:16:49Z

Pcy: fix silly typos

==Introduction==
Many of our users use the same popular software. However, as is common in popular and widespread software, various bugs or errors can occur in the program. These flaws can be exploited by hackers to gain access to websites or databases.

Whenever a new update is released for any popular software (e.g., WordPress, MediaWiki, Joomla) hackers will find out which security flaws have been patched, and using this knowledge, they try to find new systems flaws to gain access to the websites or databases. This is the reason why it is so critical to update the software itself, plugins, themes, or any related software as soon as the updates roll out. To help facilitate this and prevent security breaches, we have created a tool, the Software Version Checker, to help you keep the most commonly used software up-to-date. Currently, this feature is only active if you have an organization or student union account.
==What to do when you receive an e-mail==
When you receive an e-mail from the Software Version Checker, it is of utmost importance to update the software mentioned in the e-mail. It is also the best time to check if the other software you use is up-to-date. As mentioned below, our tool does not check all software.

You can find more information [[Updating WordPress|here]] on how to automate this for WordPress to save a lot of time and effort. Since updating MediaWiki can be a somewhat daunting process, we have made a more detailed guide available on [[Updating MediaWiki]].
==Supported Software==
Sadly not every piece of software can be supported. Because of this, we have decided to choose the most popular software, since they are more likely to get security breaches.
*Drupal (including modules and themes)
*Joomla (Plugins are not supported)
*MediaWiki (MediaWiki Extensions and Themes are not supported)
*phpBB (including plugins and styles)
*WordPress (including plugins and themes)
==Functionality of the Software Version Checker==
The Software Version Checker fulfills the following functions:
*Scan relevant files, detect supported software, and store in database
*Check the version and validity of outdated software
*Notify accounts that are using outdated software
==Stored Data in the database==
The following data is stored in the database:
*The location of the Software Version Checker, the plugins, extensions and themes
*The responsible organisation or student union
*The software version
*The details of the software
*The update URL for the software
*The date the entry was added
==Ignoring specific software==
The Software Version Checker has a feature that allows to specify paths that the Software Version Checker will not search. If you believe you have software that should be ignored (for example certain custom plugins or themes), you are free to e-mail a request to ulyssis@ulyssis.org. Please list your account name, the location of the specific file(s), the nature of what is being detected, and a detailed description of the specific situation.
==Ignoring Organisations/Student Unions==
The Software Version Checker also allows our users to ignore specific Organisations or Student Unions entirely. This feature is possible on request, but only after extensive deliberation with ULYSSIS. Enabling this feature also has possible consequences; no more mails about software that is outdated, unless it is enabled on request, and no possible support if the user's account gets hacked. If the account does get hacked it will be suspend immediately.

Mailbox in Thunderbird

2021-12-03T17:31:00Z

Pcy: /* Adding a ULYSSIS mailbox to Thunderbird */

When you create a ULYSSIS account, you get an email address: <code>''username''@ulyssis.org</code>. Usually, this address gets forwarded to your KU Leuven email address. However, you can choose to use it as your own [[Mailbox|ULYSSIS mailbox]].

It is possible to check this mailbox via https://webmail.ulyssis.org. However, it is far more convenient and efficient to use a standalone email client. This article will explain the process of adding a mailbox to the Thunderbird client.
==Thunderbird==
Thunderbird is a free and open source email client made by Mozilla. It is available for download at https://thunderbird.net. You can then install the downloaded file like you would install any other application. Once installed, launch Thunderbird and configure a mailbox using the steps below.

==Adding a ULYSSIS mailbox to Thunderbird==
If this is the first mailbox being added to Thunderbird, the following pop-up should come up:
[[File:First Open TB.png|left|alt=|thumb|432x432px]]

If the pop-up did not appear, or this is not your first mailbox; click the email button (highlighted in blue in the screenshot below) under the "Set Up Another Account" section:
[[File:New Mailbox.png|left|alt=|thumb|600x600px]]

Once the pop-up is present, proceed by entering the login details for your mailbox. The first step is to fill in your name, email address and password (this email adress should be your ULYSSIS username followed by <code>@ulyssis.org</code>):
[[File:Fill in email.png|left|alt=|thumb|432x432px]]

Next, the button "Configure manually..." on the bottom left will become clickable (as seen on the screenshot above). When this button is clicked, the pop-up should look like this:
[[File:Click Configure Manually.png|left|alt=|thumb|479x479px]]

Now, fill in the information as follows:

[[File:Fill advanced.png|left|alt=|thumb|479x479px]]
{| class="wikitable"
|+ Manual settings
|-
|| || INCOMING || OUTGOING
|-
|| Protocol: || IMAP || SMTP
|-
|| Server: || mail.ulyssis.org || smtps.kuleuven.be
|-
|| Port: || 993 || 443
|-
|| SSL: || SSL/TLS || SSL/TLS
|-
| style="padding-right: 10px" | Authentication:
|| Autodetect
|| Autodetect
|-
|| Username:
| style="padding-right: 10px" | ULYSSIS username
|| r/m/s/u number
|-
| colspan="3" |

Notice the ports used to configure a ULYSSIS mailbox are not automatically recognized by Thunderbird. This means they should be entered manually instead of using the drop-down.
|}

The "Re-test" button on the bottom right of the following screenshot is used to validate the settings. When pressed, Thunderbird will try to connect to the mail server. When successful, the pop-up should look like this:

[[File:After Clicking Retest GOOD.png|left|alt=|thumb|479x479px]]

If this test succeeds, the pop-up will close when the "Done" button has been clicked. After the pop-up closes, a mailbox should be added to the left sidebar of the main Thunderbird window. By clicking on the inbox tab, your emails should start showing up (as seen in the last screenshot). After finishing up this setup, your mailbox should synchronize automatically.

[[File:After Clicking GetMessages.png|left|alt=|thumb|600x600px]]

{{notice|Use your KU Leuven login for the outgoing (SMTP) mailserver|When sending the first email after configuration, Thunderbird might show a pop-up: "Enter your password for r0000000 on smtps.kuleuven.be:". It is really important to enter your KU Leuven password (the password used for central login), otherwise your email will not be sent.}}

[[Category:Mail]]

Mailbox in Thunderbird

2021-12-03T17:27:52Z

Pcy: spelling tweaks etc

When you create a ULYSSIS account, you get an email address: <code>''username''@ulyssis.org</code>. Usually, this address gets forwarded to your KU Leuven email address. However, you can choose to use it as your own [[Mailbox|ULYSSIS mailbox]].

It is possible to check this mailbox via https://webmail.ulyssis.org. However, it is far more convenient and efficient to use a standalone email client. This article will explain the process of adding a mailbox to the Thunderbird client.
==Thunderbird==
Thunderbird is a free and open source email client made by Mozilla. It is available for download at https://thunderbird.net. You can then install the downloaded file like you would install any other application. Once installed, launch Thunderbird and configure a mailbox using the steps below.

==Adding a ULYSSIS mailbox to Thunderbird==
If this is the first mailbox being added to Thunderbird, the following pop-up should come up:
[[File:First Open TB.png|left|alt=|thumb|432x432px]]

If the pop-up did not appear, or this is not your first mailbox; click the email button (highlighted in blue in the screenshot below) under the "Set Up Another Account" section:
[[File:New Mailbox.png|left|alt=|thumb|600x600px]]

Once the pop-up is present, proceed by entering the login details for your mailbox. The first step is to fill in your name, email address and password (this email adress should be your ULYSSIS username followed by <code>@ulyssis.org</code>):
[[File:Fill in email.png|left|alt=|thumb|432x432px]]

Next, the button "Configure manually..." on the bottom left will become clickable (as seen on the screenshot above). When this button is clicked, the pop-up should look like this:
[[File:Click Configure Manually.png|left|alt=|thumb|479x479px]]

Now, fill in the information as follows:

[[File:Fill advanced.png|left|alt=|thumb|479x479px]]
{| class="wikitable"
|+ Manual settings
|-
|| || INCOMING || OUTGOING
|-
|| Protocol: || IMAP || SMTP
|-
|| Server: || mail.ulyssis.org || smtps.kuleuven.be
|-
|| Port: || 993 || 443
|-
|| SSL: || SSL/TLS || SSL/TLS
|-
| style="padding-right: 10px" | Authentication:
|| Autodetect
|| Autodetect
|-
|| Username:
| style="padding-right: 10px" | ULYSSIS username
|| r/m/s/u number
|-
| colspan="3" |

Notice the ports used to configure a ULYSSIS mailbox are not automatically recognized by Thunderbird. This means they should be entered manually instead of using the drop-down.
|}

The "Re-test" button on the bottom right of the following screenshot is used to validate the settings. When pressed, Thunderbird will try to connect to the mail server. When successful, the pop-up should look like this:

[[File:After Clicking Retest GOOD.png|left|alt=|thumb|479x479px]]

If this test succeeds, the pop-up will close when the "Done" button has been clicked. After the pop-up closes, a mailbox should be added to the left sidebar of the main Thunderbird window. By clicking on the inbox tab, your emails should start showing up (as seen in the last screenshot). After finishing up this setup, your mailbox should synchronize automatically.
[[File:After Clicking GetMessages.png|left|alt=|thumb|600x600px]]

When sending the first email after configuration, Thunderbird might show a pop-up: "Enter your password for r0000000 on smtps.kuleuven.be:". It is really important to enter your KU Leuven password (the password used for central login), otherwise your email will not be sent.

[[Category:Mail]]

Using (Fast)CGI for non-PHP websites

2021-04-28T22:20:03Z

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

You're not stuck with PHP if you want to make a dynamic website. You can use all sorts of frameworks and programming languages with ULYSSIS, as long as it has CGI or FastCGI support.

If you want to use a certain programming language or framework, and you can't get it to work, don't hesitate to contact us at [mailto:ulyssis@ulyssis.org ulyssis@ulyssis.org]. We will of course not write any code for you, but we can give you some pointers or directions.

==CGI==

CGI is a simple way to create a dynamic website. We use Apache's [http://httpd.apache.org/docs/2.4/mod/mod_cgid.html mod_cgid] to provide support for CGI. Note, however, that CGI is inefficient and
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 <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
AddHandler cgi-script .cgi</pre>

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

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

CGI scripts need to be executable, otherwise they won't work:
<pre>chmod +x hello.cgi</pre>

==FastCGI==

We use Apache's [http://httpd.apache.org/mod_fcgid/mod/mod_fcgid.html mod_fcgid] to provide support for FastCGI.

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 <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
AddHandler fcgid-script .fcgi
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^(.*)$ starter.fcgi/$1 [QSA,L]</syntaxhighlight>
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>
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.}}
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 ===

It is important to keep in mind that our Apache webworkers will only run your start script when a request is made. As soon as that first request has been received, it will try and keep a few instances of your application around for future use. This of course affects how you restart your application after changes (see below), but also means that applications with a longer start up time (for example a language such as Python combined with a larger framework) will experience an initial slow request. This slow startup is obviously not a factor for faster languages such as Haskell, C++ or Go.

Sadly, Apache is unable to have FastCGI processes persist beyond a reload or restart. This means in practice that every night around 6h25 when the logs are rotated, which requires Apache to be reloaded, all running fcgi processes will be gracefully terminated. The same thing happens when we make changes to the Apache configuration when a new website or user is added.

For those who have a very high startup time and don't generate enough traffic to not experience issues with this behaviour, it's possible to use a [[Managing_Cron_jobs | cronjob]] to visit the website every night at 6h30 or 7h, or even hourly.

===Restarting your application===

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>:
<pre>touch starter.fcgi</pre>
Replace <code>starter.fcgi</code> with the name of your starter script.

=== Examples ===
==== Python and Django ====

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>
<li>[[Accessing shell servers over SSH|Log in to a shell server]]</li>
<li>Create a new virtualenv, you can create one in <code>~/.venv</code>, for example:
<pre>python3 -m venv ~/.venv</pre>
</li>
<li>Activate this virtualenv:
<pre>. ~/.venv/bin/activate</pre>
</li>
<li>
Install Django inside of this virtualenv:
<pre>pip install django</pre>
</li>
<li>
Create a new Django project:
<pre>django-admin.py startproject mysite</pre>
Replace ''mysite'' with your project's desired name.
</li>
<li>
Install flup for FastCGI:
<pre>pip install flup6</pre>
</li>
<li>
Put an <code>.htaccess</code> file in your site's directory, e.g. the <code>www</code> folder:
<pre>Options +ExecCGI
AddHandler fcgid-script .fcgi
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^(.*)$ mysite.fcgi/$1 [QSA,L]</pre>
</li>
<li>
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

import sys, os, os.path
from threading import Thread

this_file = os.path.realpath(__file__)

site_dir = '/home/user/username/mysite'
sys.path.insert(0, site_dir)
os.chdir(site_dir)

os.environ['DJANGO_SETTINGS_MODULE'] = 'mysite.settings'

def stat_thread():
import time, os, signal
start_mtime = os.stat(this_file).st_mtime
while True:
cur_mtime = os.stat(this_file).st_mtime
if cur_mtime != start_mtime:
os.kill(os.getpid(), signal.SIGTERM)
time.sleep(1)

Thread(target=stat_thread).start()

from django.core.servers.basehttp import get_internal_wsgi_application
from flup.server.fcgi import WSGIServer
WSGIServer(get_internal_wsgi_application(), debug=False).run()
</syntaxhighlight>
Call this script <code>mysite.fcgi</code>.
</li>
<li>
Make the starter script executable:
<pre>chmod +x mysite.fcgi</pre>
</li>
<li>
Go to ''username''.ulyssis.be (or whatever URL you chose to use), and it should show you the default "Welcome to Django" page.
</li>
</ol>

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://flask.palletsprojects.com/en/1.1.x/deploying/fastcgi/ Flask documentation for FastCGI]

==== 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 <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
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 <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

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 <code>mysite.fcgi.go</code> and then use <code>go build</code> to compile it.
</li>
<li>Visit your website to verify everything works</li>
</ol>

[[Category:Webserver]]

Getting SSL/TLS

2021-04-20T13:04:04Z

Pcy: /* Let's Encrypt */ fullchain verduidelijking

ULYSSIS does not sell or offer any other SSL certificates than our self-signed certificate. We will however guide requests and install a certificate from the KU Leuven is you are eligible for one, and we will also install certificates you have bought or obtained elsewhere.

==Requesting SSL from the KU Leuven==

The KU Leuven partners with other universities through TERENA/Géant to arrange certificates for its services, organisations and academic structures. We have permission to request free SSL/TLS certificates for student unions (kringen) recognized by LOKO or faculty consultative bodies (facultaire overlegorganen) recognized by Studentenraad KU Leuven as well as organisations (vrije verenigingen) recognized by LOKO or KU Leuven. We are not eligible to request SSL/TLS certificates for individuals with a personal account, nor research groups or staff associations. We suggest those latter groups request certificates from KU Leuven ICTS directly or consider Let's Encrypt or another third party service.

Before sending us a request, the following steps have to be performed:
* Set up the site that needs SSL if that's not already the case
* Make sure our nameservers are being used for the involved domain(s), as explained on [[Adding domain names]]
* Consider all subdomains (whether separate websites or not) you wish to have certificates for
* Make a list of all relevant arguments for your use of SSL/TLS certificates. It's important to consider aspects of your website where important or personal information is exchanged: registration, login pages, newsletter signup, etc.

When '''all''' steps are done, the account holder of the ULYSSIS account can send an email to ulyssis@ulyssis.org containing their name, the name of the organisation, the relevant arguments what you will use SSL for and the domain and if needed a list of subdomains that should be covered by the certificate.

Based on our previous experience and our arrangements with ICTS we will consider whether you are eligible for certificates and whether your request is well-founded. We will then generate the required cryptographic key and request and submit them on the certificate platform supplied by ICTS and its partners. Depending on the situation, the verification and delivery of the certificate can take some time. As soon as the certificate has been issued, we will install it and notify you.

For procedures to request certificates, we follow instructions from ICTS. These instructions have changed several times in the past, so it's possible for a new request or for a renewal, you may have to follow a different procedure or make changes.

{{notice|Limitations|ICTS does not allow SSL requests for historic *.student.kuleuven.be domains. We judge requests for username.ulyssis.be and username.studentenweb.org on an individual basis.}}

==External certificates==
To install external certificates we require the certificate itself, the private key, and possibly the chain. We prefer you also send us (a link to) the documentation of your supplier. As certificate files, especially private keys, are a delicate matter we suggest you just email us the path in your homedirectory you've put them and we will move them over to the webserver safely. For more information concerning this procedure you can always contact us on ulyssis@ulyssis.org

===Let's Encrypt===
We currently do not have an automated system for renewing and deploying certificates such as those supplied by Let's Encrypt. We are however looking into automating this process in the future. Since more of our users are starting to use Let's Encrypt, and all of their certificates need to be renewed frequently, we have a specific procedure now.

When wishing to add a certificate with Let's Encrypt to your website, or renew your existing one, first create a folder <code>letsencrypt</code> in your '''home directory'''. Then add a folder per domain or group of domains:

mkdir -p ~/letsencrypt/mydomain.be

Certificates should be stored in these folders, according to the following file structure:

letsencrypt/
└── mydomain.be/
├── mydomain.be.chain (the CA file; "full chain", not the regular chain)
├── mydomain.be.crt (the cert file; "public key")
└── mydomain.be.key (the key file; "private key")

If you already possess the necessary files, renaming and copying them accordingly is sufficient.
'''You still have to email us to install your certificate.''' More information in the last section on this page.

Otherwise, you can generate or renew your certificates using acme.sh. This is explained in the next section.

==== Generating certificates ====
{{notice|If you use a <code>.htaccess</code> file in the webroot of the domain name, make sure to add the following lines at the top of the file:|<pre><IfModule mod_rewrite.c>
RewriteRule "^.well-known/acme-challenge" - [L]
</IfModule></pre>}}
Because the normal method of generating Let's Encrypt certificates, certbot, requires root access, it's impossible for normal users to do so on our servers. Luckily there are plenty of alternatives which implement the Let's Encrypt protocol. In this tutorial, we'll show how to use the acme.sh program to generate certificates on the ULYSSIS servers. '''If you already followed this section to generate certificates, skip to the next section on renewing certificates.'''

Firstly, execute the following commands to download the acme.sh script in your home directory and make it executable:

curl -o ~/acme.sh https://raw.githubusercontent.com/acmesh-official/acme.sh/master/acme.sh
chmod +x ~/acme.sh

Next, determine for which domains and subdomains you want to generate a certificate. You will need to generate a single certificate for each domain and subdomain which points to the same folder on your account (in most cases this is <code>www</code> in your home directory).

The following example command will generate a certificate for <code>mydomain.be</code> and <code>www.mydomain.be</code> which points to the <code>www</code> folder in the home directory. '''Change the parameters''' as explained below before executing this command!

~/acme.sh --issue --cert-file ~/letsencrypt/mydomain.be/mydomain.be.crt --key-file ~/letsencrypt/mydomain.be/mydomain.be.key --ca-file ~/letsencrypt/mydomain.be/mydomain.be.chain -m "email@mydomain.be" -w ~/www -d mydomain.be -d www.mydomain.be

The explanation of these many parameters is as follows:
* <code>--issue</code> tells acme.sh to generate a new certificate.
* <code>--cert-file ~/letsencrypt/mydomain.be/mydomain.be.crt</code> tells acme.sh to store the certificate file in the <code>letsencrypt/mydomain.be</code> folder in your home directory, using the special file name as required by the file structure. '''This folder should already exist''', please refer to the previous section if you have not created this folder yet.
* <code>--key-file ~/letsencrypt/mydomain.be/mydomain.be.key</code> tells acme.sh to store the key file in the <code>letsencrypt/mydomain.be</code> folder in your home directory, using the special file name as required by the file structure.
* <code>--ca-file ~/letsencrypt/mydomain.be/mydomain.be.chain</code> tells acme.sh to store the CA file in the <code>letsencrypt/mydomain.be</code> folder in your home directory, using the special file name as required by the file structure.
* <code>-m "email@mydomain.be"</code> tells acme.sh the email address associated with the certificate. Let's Encrypt will remind this email address (if provided) when the certificate is close to expiring.
* <code>-w ~/www</code> tells acme.sh where the domains in this certificate point to. Make sure to change the <code>www</code> part if the domains point to a different folder in your home directory.
* <code>-d mydomain.be</code> and <code>-d www.mydomain.be</code> tell acme.sh that the certificate should protect <code>mydomain.be</code> and <code>www.mydomain.be</code>. The first domain name will be the "main domain", which is important for renewing. You should '''add all domain names''' pointing to the <code>-w</code> folder.

After executing this command with the right parameters, your certificate should be generated successfully. When you have to renew the certificate in the future, you should follow the instructions in the next section. '''Don't forget to email us to install your new certificate.''' More information in the last section on this page.

==== Renewing certificates ====
To renew the certificates of <code>mydomain.be</code>, just execute:
~/acme.sh --renew -d mydomain.be

For the <code>-d</code> parameter, you have to provide the '''first''' domain name you provided when generating the certificate (in the previous section, this was <code>mydomain.be</code>.

If you are not sure which domain name to use, you can execute the command:
~/acme.sh --list

This will generate a list of available certificates, which looks a bit like this:
Main_Domain KeyLength SAN_Domains CA Created Renew
mydomain.be "" www.mydomain.be LetsEncrypt.org ... ...
... ... ... ... ... ...

In this example, the main domain is <code>mydomain.be</code>.

The renewed certificates will automatically be copied to the files you provided in the command to generate the certificates (see previous section).

'''After renewing the certificate, you have to email us to install your certificate.''' More information in the next section.

==== Getting your certificates installed ====
Check whether everything is stored correctly by executing the following command:
ulyssis-certificate check mydomain.be

If everything looks good, you should only see lines starting with <code>[ OK ]</code>. Any line starting with <code>[FAIL]</code> or <code>[ABRT]</code> means a check has failed, you must correct this error before asking us to install your certificate.

Once all steps are done and if you are the '''account holder''', '''you can send us an email clearly stating the account name, for which domains we need to add certificates and where the files are stored'''. If you are renewing existing certificates, also clearly state that in your email.

We have largely automated the installation of certificates. If you do not follow these instructions, your request will be denied or you may end up with broken SSL, so make sure you follow this procedure carefully.

[[Category:Webserver]]

Reducing disk usage

2021-03-08T07:28:33Z

Pcy: fix spelling etc

__TOC__
This page discusses what happens when you use more disk space than has been allotted to your account (your quota) and how to reduce your disk usage. You may have been pointed here through an automatic email notification you are running over your quota, or through our support. This page is also useful if you want to reduce your disk usage even if you're not using more than your quota. You can check your current disk usage as well as your quota on https://ucc.ulyssis.org/quota.

This page first discusses what happens when you use more disk space than is available to your account type (so you therefore go over your quota). This is followed by a detailed manual on how to use the command line tool ''ncdu'' to look for the files and folders that may be causing trouble within your account. Finally, there's a list of examples of common causes for large disk space usage.

== What happens when I go over my quota? ==

If you are using more disk space than the allowed quota for your account type for more than seven consecutive days (the so-called grace period), you will no longer be able to write any additional files or extend existing files. You will probably no longer be able to edit websites on your account or it might even stop working outright. If you haven't configured a forwarder for your <code>''username''@ulyssis.org</code> email address, you will lose emails sent to this address. The grace period of seven days is intended for you to have time to reduce your disk space. You will receive an email every day reminding you that you are using too much disk space. In order to prevent impact on other users in cases where disk usage within an account suddenly and substantially surges, an additional quota slightly higher than your normal quota is imposed, independent of any grace period.

== Identifying which files & folders use the most disk space ==
It is not always easy to immediately identify what is taking up space on your account. Sadly, there are no dependable cross-platform tools to help with this. Instead, we will be using the command line tool ''ncdu'', which runs directly on one of our shell servers. You do not need to be proficient with command line interfaces in order to use this tool, the step-by-step manual below will guide you through the process. However, should you get stuck, do not hesitate to contact us at <code>ulyssis@ulyssis.org</code>.

* Connect through SSH to one of the shell servers: https://docs.ulyssis.org/Accessing_shell_servers_over_SSH
* Type in <code>ncdu</code> and press enter. You will then see that <code>ncdu</code> is scanning your account.
* Once <code>ncdu</code> has finished scanning, it will display which files or folders located directly in your home directory are using the most disk space. When the filename stars with <code>/</code> it is a folder. The results are ordered by size, so it makes most sense to start with the top items.
* You can select different files/folders using the '''up and down arrow keys''', navigate the directory structure using either the '''enter and backspace''' keys or the '''left and right''' arrows to move in and out of folders, quit ncdu by pressing '''q''' and delete a file or folder with '''d'''. Be careful to not delete files you still need as you will need to contact us in order to restore them from a backup.
* You can check your progress on https://ucc.ulyssis.org/quota. The percentage and values displayed are always current and accurate, there is no delay.[[File:Disk usage ncdu.png|thumb|760x760px]]

=== Common sources of unnecessary disk usage ===

* Your ULYSSIS mailbox: Depending on your account settings, your ''@ulyssis.org'' email account may be used as a forwarder or an inbox. When set to ''Inbox'' on https://ucc.ulyssis.org/mail, email will be saved to the ''Maildir'' folder within your account. A substantial amount of email, especially with large attachments, may grow to quite a significant size. You can verify the contents of your mailbox easily by logging in on https://webmail.ulyssis.org using your ULYSSIS account credentials. You can then remove those emails that are no longer useful, and don't forget to empty the trash. To remove the entire mailbox, you can simply remove the Maildir folder from your account (using ncdu, FileZilla, or another tool). To empty the trash manually, you can remove the ''Maildir/.Trash'' folder. If you no longer wish to use you mailbox, don't forget to change the configuration on https://ucc.ulyssis.org/mail to forward your messages, since you may receive relevant information about your account through this address.
* Old websites: if you have older websites on your account that you are no longer using, it might be worth removing them in their entirety. If the deleted website uses a database (this will always be the case if your using WordPress, MediaWiki or another popular CMS), then you should also delete those through our control panel: https://ucc.ulyssis.org (either the MySQL or PostgreSQL sections). If this website had an associated (sub)domain, please send us an email to have it removed. Also keep in mind that old websites may pose a security risk, so it's never good to leave them lying about.
* Unused images: in the case of many CMSes (WordPress, Drupal, ...), removing an image from a post will not delete it. For example, in the case of WordPress it will still be available through the [https://wordpress.com/support/media/deleting-files/ Media Library]. In order to reclaim the disk space used by the image, you will have to delete it there as well. Similarly, MediaWiki offers a list of ''unused files'' as a special page available in the list of ''Special Pages''.
* Large images: images and especially pictures are often several MBs in size and often have a large resolution. While this is great for editing and printing, such large sizes are not all that useful for inclusion in a webpage. They can make your site load slower and use more disk space without a significant increase in quality. You should therefore consider resizing images before uploading them or installing a plugin, module or extension that reduces their size on upload. However, make sure to watch out for plugins that keep the original image around as this will not reduce but increase your disk usage. For a tutorial on how to resize images, you can take a look at https://wordpress.com/support/media/image-optimization/. This tutorial is geared towards WordPress, but is also applicable in general. If you are using MediaWiki, we have written a plugin that reduces the size of various types of files. You can find more details on [[Setting up MediaWiki#Extensions|Setting up MediaWiki - Extensions]].
* Backups: ULYSSIS makes daily backups of all account data, including databases, and keeps them for at least a month. It is therefore not necessary to make automated backups of your own, for example with plugins such as [https://nl.wordpress.org/plugins/updraftplus/ Updraft] for WordPress. Although it is a good practice to make backups whenever you are making large changes to your site, it is not necessary to keep them after you have verified that your site works correctly.
* Anything missing on this list? Feel free to contact us on <code>ulyssis@ulyssis.org</code> with your suggestions.
[[Category:Files]]
[[Category:Account]]

Transferring your account

2021-02-27T11:49:54Z

Pcy: fix grammar & wording

You can transfer the account of your (faculty) organization to a new webmaster. The new webmaster must have a valid Central KU Leuven Login. Otherwise, the new webmaster will not be able to accept the account transfer.

The instructions below must be executed by the current account owner.

* Log in to [https://ucc.ulyssis.org/ UCC].
* Click 'Transfer account' in the menu on the right.
* Enter the details of the new account owner. Ensure the KULeuven email address is entered correctly.

The new webmaster will receive an email to confirm the transfer.

[[Category:Account]]

Using MySQL

2020-12-16T18:04:32Z

Pcy: fix wording and punctuation a little bit

MySQL is one of the most popular databases for websites. It's used by most CMSes and other common web software, and many programming languages have support for it. ULYSSIS specifically uses MariaDB, which is a fork of MySQL with similar features and (almost) identical SQL syntax, but offers better performance and has less corporate interference in the development process.

== Managing MySQL ==
All common management tasks can be performed through our control panel [https://ucc.ulyssis.org UCC], under the MySQL section.

===Creating a MySQL user===
To use MySQL on your ULYSSIS account, you first need to create a MySQL user on [https://ucc.ulyssis.org UCC]. In the MySQL section of the panel, you will be suggested to click a link to create a user. Then fill in a password for the database user. It is highly recommended that this password differs from the password you use for your account. Finally, click ''Create user'' and you are ready to go.

===Creating a MySQL database===
After having created a MySQL user, you can click ''Add database'' in [https://ucc.ulyssis.org UCC] and enter the name for your new database. It will automatically be prefixed by your username.

===Deleting a MySQL database===
If you no longer need a database, you can easily remove it by clicking on ''MySQL'' in [https://ucc.ulyssis.org UCC] and then pressing on ''Remove database'' next to the database you would like to delete. After confirming, the database and all its tables and other contents will be gone. For security reasons, you can't remove databases using an SQL query like DROP DATABASE, but have to go through UCC.

== Accessing MySQL ==
Our MySQL and PostgreSQL databases run on a separate database server, this means you may need to enter a specific host, together with the correct credentials, to access your database within a website or application. You may also wish to use a common tool such as PHPMyAdmin or access a database remotely. Details on how to do that are available in the sections below.

===Using MySQL for your website or application===
Host: mysql.ulyssis.org
Username: your account's username
Password: the password you chose when you made the MySQL user
Database: the database name you chose, prefixed by your username

For example, if my username is foobar, I made a database called website and I were to create a PHP website I would use something like:
<syntaxhighlight lang="php">$db = new mysqli('mysql.ulyssis.org', 'foobar', 'correct horse battery staple', 'foobar_website');</syntaxhighlight>
or
<syntaxhighlight lang="php">$db = new PDO('mysql:host=mysql.ulyssis.org;dbname=foobar_website', 'foobar', 'correct horse battery staple');</syntaxhighlight>

===Accessing MySQL with PHPMyAdmin or Adminer===
Using your username and password you can easily manage your MySQL databases, tables and records on https://phpmyadmin.ulyssis.org and https://adminer.ulyssis.org. Documentation is also available to aid in [[using PHPMyAdmin]] and [[using Adminer]].

===Accessing MySQL from outside of our network===
To prevent unnecessary load on our database server by hackers and bots it is only available inside of our network. If you wish to access it externally the easiest way is to use an SSH tunnel. In many MySQL management tools this is already supported.

==== MySQL Workbench ====
While [https://www.mysql.com/products/workbench/ MySQL Workbench] might not fully support our MySQL database, all commonly used operations work perfectly. You can connect to our database using MySQL Workbench by creating a connection as follows ([username] should be replaced by your username, of course):
[[File:MySQL_Workbench_SSH.png]]

==== Linux, Mac OSX ====
On Linux, Mac OSX and other Unix-like Operating Systems it is also easily possible to use the following command to create a tunnel to a local port (in this case 3300)
ssh username@ssh2.ulyssis.org -L 3300:mysql.ulyssis.org:3306 -N

While this command is running, you can connect to the MySQL server with host 'localhost' and port '3300'.
To terminate the port forwarding, press ctrl-C in the terminal.

You can use "ssh -f username@ssh2.ulyssis.org -L 3300:mysql.ulyssis.org:3306 -N": the f-argument will put the command in the background.

[[Category:Databases]]

ULYSSIS public IRC

2020-07-28T00:54:04Z

Pcy: /* Using Bitlbee */

ULYSSIS hosts its own IRC network. IRC stands for Internet Relay Chat, [https://en.wikipedia.org/wiki/Internet_Relay_Chat IRC on wikipedia]. It is a chat protocol that mainly focuses on group chat, but also allows for private chat.

If you have an urgent question, IRC is often the quickest way to contact us. But also if you don't have a question and just want to hang out in our chat, feel free to join!

==Web IRC client==
If you won't regularly use our IRC or if you just want to check it out, you can use our web IRC client. You can find it at [https://webirc.ulyssis.org/ webirc.ulyssis.org].

==IRC network details==

Below are specific instructions for some clients, but if you are already familiar with IRC, here are the details you need to connect to our server. We highly recommend using SSL.

Server: irc.ulyssis.org
Port: 6668 (SSL)
Channel: #ulyssis

If <code>irc.ulyssis.org</code> is down, you can also try the other server in the same network, hosted at <code>irc2.ulyssis.org</code>. Both are connected to each other and you can use them interchangeably. It is advised to add it as a fallback in your IRC client.

==IRC clients==
To use IRC, you'll need an IRC client. We advise the terminal based [https://irssi.org/ irssi] or [https://weechat.org/ weechat] for Linux and [https://hexchat.github.io/ hexchat] or [https://www.mirc.com/ mIRC] for Windows, but there are a lot of other free options.

You can only receive messages over IRC while you're connected. Therefore, we advise you to run irssi or weechat in either a screen or a tmux session. With a ULYSSIS account, you can run screen or tmux on our shellservers, as they keep running 24/7 you can use them to keep track of your conversations.
Screen and tmux are similar programs. Screen has been around for longer and is more tested, while tmux is more modern with new features and being easier to use for beginners.

===Using irssi on our shell servers===
====Connect to the shellserver====
Use the ssh command in your Linux or OS X terminal, or use PuTTY to connect on windows.
Extensive information on how to do so can be found on [[Accessing shell servers over SSH]].

====Start irssi in a screen====
*When on the shellserver, enter <code>screen -U</code> to start a screen session, or <code>tmux</code> to start a tmux session.
*Enter <code>irssi</code> to start irssi
*Connect to the IRC server: <code>/server -ssl irc.ulyssis.org 6668</code>
*Connect to the public channel: <code>/join #ulyssis</code>

====Screen usage====
*To exit the screen: press Ctrl-A and press D ('detach') to return to the shellserver.
*To reconnect: enter <code>screen -r</code> or <code>screen -DR</code> (the latter will create a new screen if it wasn't already made).

====Tmux usage====
*To exit the tmux session: press Ctrl-B and press D ('detach') to return to the shellserver.
*To reconnect: enter <code>tmux attach</code>

====Help, I can't reconnect to my session!====
*Check if you are on the right shell server and didn't make a typing error.
*If everything is correct, your screen may have been stopped by a crash or a reboot of our shellserver. You can check the [http://www.ulyssis.org/status status] section of our website for more information about possible downtimes.
*Make sure you use the right program (<code>screen</code> if you started a screen session and <code>tmux</code> if you started a tmux session)

==Using ZNC==
Alternatively, if you don't like using terminal-based clients, or just want to run your client locally, you can connect with our [https://znc.ulyssis.org/ ZNC server]. However, to use it, you'll need a ULYSSIS account. ZNC connects to our IRC server in your place (fill in the details at the beginning of this article). You can then connect to ZNC with a client of your choice, and it will send you the history you've missed while you were offline.

Log in to our ZNC server. In your settings, create a new network. Fill in the basic details (server name, nickname, set <code>BindHost</code> to <code>0.0.0.0</code>). In the server field, fill in <code>irc.ulyssis.org +6668</code>. Add <code>#ulyssis</code> as a channel. You may want to increase the buffer count. Then save at the bottom of the page.

In your IRC client, connect to the server <code>znc.ulyssis.org</code> on port 6666 (with SSL) and set <code>username/network:password</code> as password to the server. Replace <code>username</code> with your ULYSSIS username, <code>network</code> with the name of the network in your znc settings, and <code>password</code> with your ULYSSIS password.

==Using Bitlbee==

With [https://www.bitlbee.org/main.php/news.r.html Bitlbee], you can connect to other services as if they were an IRC server. It is available at <code>bitlbee.ulyssis.org</code> on ports 7000 and 7001 (SSL). For documentation on how to use Bitlbee, we refer to the manual on its website. This service is only reachable from within the ULYSSIS and KU Leuven networks.

[[Category:Shell]]
[[Category:ULYSSIS Public Services]]

ULYSSIS public IRC

2020-07-28T00:46:09Z

Pcy: /* Using Bitlbee */

ULYSSIS hosts its own IRC network. IRC stands for Internet Relay Chat, [https://en.wikipedia.org/wiki/Internet_Relay_Chat IRC on wikipedia]. It is a chat protocol that mainly focuses on group chat, but also allows for private chat.

If you have an urgent question, IRC is often the quickest way to contact us. But also if you don't have a question and just want to hang out in our chat, feel free to join!

==Web IRC client==
If you won't regularly use our IRC or if you just want to check it out, you can use our web IRC client. You can find it at [https://webirc.ulyssis.org/ webirc.ulyssis.org].

==IRC network details==

Below are specific instructions for some clients, but if you are already familiar with IRC, here are the details you need to connect to our server. We highly recommend using SSL.

Server: irc.ulyssis.org
Port: 6668 (SSL)
Channel: #ulyssis

If <code>irc.ulyssis.org</code> is down, you can also try the other server in the same network, hosted at <code>irc2.ulyssis.org</code>. Both are connected to each other and you can use them interchangeably. It is advised to add it as a fallback in your IRC client.

==IRC clients==
To use IRC, you'll need an IRC client. We advise the terminal based [https://irssi.org/ irssi] or [https://weechat.org/ weechat] for Linux and [https://hexchat.github.io/ hexchat] or [https://www.mirc.com/ mIRC] for Windows, but there are a lot of other free options.

You can only receive messages over IRC while you're connected. Therefore, we advise you to run irssi or weechat in either a screen or a tmux session. With a ULYSSIS account, you can run screen or tmux on our shellservers, as they keep running 24/7 you can use them to keep track of your conversations.
Screen and tmux are similar programs. Screen has been around for longer and is more tested, while tmux is more modern with new features and being easier to use for beginners.

===Using irssi on our shell servers===
====Connect to the shellserver====
Use the ssh command in your Linux or OS X terminal, or use PuTTY to connect on windows.
Extensive information on how to do so can be found on [[Accessing shell servers over SSH]].

====Start irssi in a screen====
*When on the shellserver, enter <code>screen -U</code> to start a screen session, or <code>tmux</code> to start a tmux session.
*Enter <code>irssi</code> to start irssi
*Connect to the IRC server: <code>/server -ssl irc.ulyssis.org 6668</code>
*Connect to the public channel: <code>/join #ulyssis</code>

====Screen usage====
*To exit the screen: press Ctrl-A and press D ('detach') to return to the shellserver.
*To reconnect: enter <code>screen -r</code> or <code>screen -DR</code> (the latter will create a new screen if it wasn't already made).

====Tmux usage====
*To exit the tmux session: press Ctrl-B and press D ('detach') to return to the shellserver.
*To reconnect: enter <code>tmux attach</code>

====Help, I can't reconnect to my session!====
*Check if you are on the right shell server and didn't make a typing error.
*If everything is correct, your screen may have been stopped by a crash or a reboot of our shellserver. You can check the [http://www.ulyssis.org/status status] section of our website for more information about possible downtimes.
*Make sure you use the right program (<code>screen</code> if you started a screen session and <code>tmux</code> if you started a tmux session)

==Using ZNC==
Alternatively, if you don't like using terminal-based clients, or just want to run your client locally, you can connect with our [https://znc.ulyssis.org/ ZNC server]. However, to use it, you'll need a ULYSSIS account. ZNC connects to our IRC server in your place (fill in the details at the beginning of this article). You can then connect to ZNC with a client of your choice, and it will send you the history you've missed while you were offline.

Log in to our ZNC server. In your settings, create a new network. Fill in the basic details (server name, nickname, set <code>BindHost</code> to <code>0.0.0.0</code>). In the server field, fill in <code>irc.ulyssis.org +6668</code>. Add <code>#ulyssis</code> as a channel. You may want to increase the buffer count. Then save at the bottom of the page.

In your IRC client, connect to the server <code>znc.ulyssis.org</code> on port 6666 (with SSL) and set <code>username/network:password</code> as password to the server. Replace <code>username</code> with your ULYSSIS username, <code>network</code> with the name of the network in your znc settings, and <code>password</code> with your ULYSSIS password.

==Using Bitlbee==

With [https://www.bitlbee.org/main.php/news.r.html Bitlbee], you can connect to other services as if they were an IRC server. It is available at <code>irc.ulyssis.org</code> on ports 7000 and 7001 (SSL). For documentation on how to use Bitlbee, we refer to the manual on its website. This service is only reachable from within the ULYSSIS and KU Leuven networks.

[[Category:Shell]]
[[Category:ULYSSIS Public Services]]

ULYSSIS public IRC

2020-07-28T00:35:46Z

Pcy:

ULYSSIS hosts its own IRC network. IRC stands for Internet Relay Chat, [https://en.wikipedia.org/wiki/Internet_Relay_Chat IRC on wikipedia]. It is a chat protocol that mainly focuses on group chat, but also allows for private chat.

If you have an urgent question, IRC is often the quickest way to contact us. But also if you don't have a question and just want to hang out in our chat, feel free to join!

==Web IRC client==
If you won't regularly use our IRC or if you just want to check it out, you can use our web IRC client. You can find it at [https://webirc.ulyssis.org/ webirc.ulyssis.org].

==IRC network details==

Below are specific instructions for some clients, but if you are already familiar with IRC, here are the details you need to connect to our server. We highly recommend using SSL.

Server: irc.ulyssis.org
Port: 6668 (SSL)
Channel: #ulyssis

If <code>irc.ulyssis.org</code> is down, you can also try the other server in the same network, hosted at <code>irc2.ulyssis.org</code>. Both are connected to each other and you can use them interchangeably. It is advised to add it as a fallback in your IRC client.

==IRC clients==
To use IRC, you'll need an IRC client. We advise the terminal based [https://irssi.org/ irssi] or [https://weechat.org/ weechat] for Linux and [https://hexchat.github.io/ hexchat] or [https://www.mirc.com/ mIRC] for Windows, but there are a lot of other free options.

You can only receive messages over IRC while you're connected. Therefore, we advise you to run irssi or weechat in either a screen or a tmux session. With a ULYSSIS account, you can run screen or tmux on our shellservers, as they keep running 24/7 you can use them to keep track of your conversations.
Screen and tmux are similar programs. Screen has been around for longer and is more tested, while tmux is more modern with new features and being easier to use for beginners.

===Using irssi on our shell servers===
====Connect to the shellserver====
Use the ssh command in your Linux or OS X terminal, or use PuTTY to connect on windows.
Extensive information on how to do so can be found on [[Accessing shell servers over SSH]].

====Start irssi in a screen====
*When on the shellserver, enter <code>screen -U</code> to start a screen session, or <code>tmux</code> to start a tmux session.
*Enter <code>irssi</code> to start irssi
*Connect to the IRC server: <code>/server -ssl irc.ulyssis.org 6668</code>
*Connect to the public channel: <code>/join #ulyssis</code>

====Screen usage====
*To exit the screen: press Ctrl-A and press D ('detach') to return to the shellserver.
*To reconnect: enter <code>screen -r</code> or <code>screen -DR</code> (the latter will create a new screen if it wasn't already made).

====Tmux usage====
*To exit the tmux session: press Ctrl-B and press D ('detach') to return to the shellserver.
*To reconnect: enter <code>tmux attach</code>

====Help, I can't reconnect to my session!====
*Check if you are on the right shell server and didn't make a typing error.
*If everything is correct, your screen may have been stopped by a crash or a reboot of our shellserver. You can check the [http://www.ulyssis.org/status status] section of our website for more information about possible downtimes.
*Make sure you use the right program (<code>screen</code> if you started a screen session and <code>tmux</code> if you started a tmux session)

==Using ZNC==
Alternatively, if you don't like using terminal-based clients, or just want to run your client locally, you can connect with our [https://znc.ulyssis.org/ ZNC server]. However, to use it, you'll need a ULYSSIS account. ZNC connects to our IRC server in your place (fill in the details at the beginning of this article). You can then connect to ZNC with a client of your choice, and it will send you the history you've missed while you were offline.

Log in to our ZNC server. In your settings, create a new network. Fill in the basic details (server name, nickname, set <code>BindHost</code> to <code>0.0.0.0</code>). In the server field, fill in <code>irc.ulyssis.org +6668</code>. Add <code>#ulyssis</code> as a channel. You may want to increase the buffer count. Then save at the bottom of the page.

In your IRC client, connect to the server <code>znc.ulyssis.org</code> on port 6666 (with SSL) and set <code>username/network:password</code> as password to the server. Replace <code>username</code> with your ULYSSIS username, <code>network</code> with the name of the network in your znc settings, and <code>password</code> with your ULYSSIS password.

==Using Bitlbee==

With [https://www.bitlbee.org/main.php/news.r.html Bitlbee], you can connect to other services as if they were an IRC server. It is available at <code>irc.ulyssis.org</code> on ports 7000 and 7001 (SSL). For documentation on how to use Bitlbee, we refer to the manual on its website.

[[Category:Shell]]
[[Category:ULYSSIS Public Services]]

Using (Fast)CGI for non-PHP websites

2019-11-10T21:40:13Z

Pcy: fix flask link

You're not stuck with PHP if you want to make a dynamic website. You can use all sorts of frameworks and programming languages with ULYSSIS, as long as it has CGI or FastCGI support.

If you want to use a certain programming language or framework, and you can't get it to work, don't hesitate to contact us at [mailto:ulyssis@ulyssis.org ulyssis@ulyssis.org]. We will of course not write any code for you, but we can give you some pointers or directions.

==CGI==

CGI is a simple way to create a dynamic website. We use Apache's [http://httpd.apache.org/docs/2.4/mod/mod_cgid.html mod_cgid] to provide support for CGI. Note, however, that CGI is inefficient and
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):
<pre>Options +ExecCGI
AddHandler cgi-script .cgi</pre>

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

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

CGI scripts need to be executable, otherwise they won't work:
<pre>chmod +x hello.cgi</pre>

==FastCGI==

We use Apache's [http://httpd.apache.org/mod_fcgid/mod/mod_fcgid.html mod_fcgid] to provide support for FastCGI.

In order to use FastCGI, you will generally need a starter script specific to your framework and application. Just do a web search for "''framework'' mod_fcgid", where you ''framework'' is the framework you're using, and you will find good instructions. There's a Django example 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:
<syntaxhighlight lang="apache">Options +ExecCGI
AddHandler fcgid-script .fcgi
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^(.*)$ starter.fcgi/$1 [QSA,L]</syntaxhighlight>
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>
The starter script must be located in the same folder as the <tt>.htaccess</tt> 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.}}
It is adviced to only place the fcgi starter script, <tt>.htaccess</tt> and static files (images, stylesheets) inside the document root.

=== Startup time and persistency ===

It is important to keep in mind that our Apache webworkers will only run your start script when a request is made. As soon as that first request has been received, it will try and keep a few instances of your application around for future use. This of course affects how you restart your application after changes (see below), but also means that applications with a longer start up time (for example a language such as Python combined with a larger framework) will experience an initial slow request. This slow startup is obviously not a factor for faster languages such as Haskell, C++ or Go.

Sadly, Apache is unable to have FastCGI processes persist beyond a reload or restart. This means in practice that every night around 6h25 when the logs are rotated, which requires Apache to be reloaded, all running fcgi processes will be gracefully terminated. The same thing happens when we make changes to the Apache configuration when a new website or user is added.

For those who have a very high startup time and don't generate enough traffic to not experience issues with this behaviour, it's possible to use a [[Managing_Cron_jobs | cronjob]] to visit the website every night at 6h30 or 7h, or even hourly.

===Restarting your application===

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 were 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>:
<pre>touch starter.fcgi</pre>
Replace ''starter.fcgi'' with the name of your starter script.

===Example: Django===

If you want to make a website using [https://www.djangoproject.com/ Django], we recommend that you use a [http://virtualenv.readthedocs.org/ virtualenv]. This tool is already preinstalled on our shell servers.

You can use the following steps to get up and running with Django at ULYSSIS:

<ol>
<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:
<pre>virtualenv ~/.venv</pre>
Or, for Python 3:
<pre>virtualenv ~/.venv --python=python3</pre>
</li>
<li>Activate this virtualenv:
<pre>. ~/.venv/bin/activate</pre>
</li>
<li>
Install Django inside of this virtualenv:
<pre>pip install django</pre>
</li>
<li>
Create a new Django project:
<pre>django-admin.py startproject mysite</pre>
Replace ''mysite'' with your project's desired name.
</li>
<li>
Install flup for FastCGI:
<pre>pip install flup6</pre>
</li>
<li>
Put an <tt>.htaccess</tt> file in your site's directory, e.g. the <tt>www</tt> folder:
<pre>Options +ExecCGI
AddHandler fcgid-script .fcgi
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^(.*)$ mysite.fcgi/$1 [QSA,L]</pre>
</li>
<li>
Create the starter script (replace ''user'' with org if you are an organization, and ''username'' with your ULYSSIS username):
<syntaxhighlight lang="python">#!/home/user/username/.venv/bin/python

import sys, os, os.path
from threading import Thread

this_file = os.path.realpath(__file__)

site_dir = '/home/user/username/mysite'
sys.path.insert(0, site_dir)
os.chdir(site_dir)

os.environ['DJANGO_SETTINGS_MODULE'] = 'mysite.settings'

def stat_thread():
import time, os, signal
start_mtime = os.stat(this_file).st_mtime
while True:
cur_mtime = os.stat(this_file).st_mtime
if cur_mtime != start_mtime:
os.kill(os.getpid(), signal.SIGTERM)
time.sleep(1)

Thread(target=stat_thread).start()

from django.core.servers.basehttp import get_internal_wsgi_application
from flup.server.fcgi import WSGIServer
WSGIServer(get_internal_wsgi_application(), debug=False).run()
</syntaxhighlight>
Call this script <tt>mysite.fcgi</tt>.
</li>
<li>
Make the starter script executable:
<pre>chmod +x mysite.fcgi</pre>
</li>
<li>
Go to ''username''.ulyssis.be (or whatever URL you chose to use), and it should show you the default "Welcome to Django" page.
</li>
</ol>

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://flask.palletsprojects.com/en/1.1.x/deploying/fastcgi/ Flask documentation for FastCGI]

[[Category:Webserver]]

Setting up WordPress

2019-11-10T21:29:12Z

Pcy: layout van 'username'

==How to install WordPress for your account==

First you need to download WordPress from their website, https://wordpress.org/download/. After you've
received a zip file, you have to extract it using your file manager (Windows: ''use right-click and select "extract all"''; OSX: ''double-click the zip, it automatically extracts''; Linux: ''right-click the file, and select "extract here"''), this gives you a directory named <code>wordpress</code>.

Next, you have to move the '''contents''' of the <code>wordpress</code> directory to your <code>www</code> directory on our servers, which can be accessed via SFTP.
If you need further instructions, you can find detailed instructions on: [[Accessing your files]].

Besides files, we also need a database to install WordPress on. If you haven't created a new database for the purpose of this installation, you can do this through UCC. Instruction on how to do this are available on [[Using MySQL]]. If you haven't created a database user yet, or don't know the password, you can also find more information there.

Now we are ready to install WordPress, so we need to visit the web installer. If you're using a custom domain based on this guide: [[Adding domain names]], you can access the installer by visiting your domain. If you do not use such a domain, the installer can be found on <code>username.studentenweb.org</code> or <code>username.ulyssis.be</code> (replace <code>username</code> with your actual username).
This is where you have to set up your website. The easiest way to do this, is by following the wizard.

The setup will ask you for your database configuration:
*'''Database Name/Databasenaam:''' the name of the MySQL database
*'''Username/Gebruikersnaam:''' your username
*'''Password/Wachtwoord:''' your MySQL database password
*'''Database Host/Hostnaam:''' <code>mysql.ulyssis.org</code>
*'''Table Prefix:''' only change this if you have multiple installations of WordPress in your database<br>
So it will look something like this:<br>
[[File:wordpress_screenshot.png|thumb|left|600px]]
In the next step you need to fill in your own preferences.

Finally you will be prompted to log into your WordPress website. Now the installation is finished.

To help you design your website, there are a few guides from WordPress that can help you:
*https://wordpress.org/support/article/first-steps-with-wordpress-b/
*https://wordpress.org/support/article/using-themes/#get-new-themes
*https://wordpress.org/support/article/managing-plugins/

==Setting up multiple instances of WordPress==

If you want to have multiple instances of a WordPress site, you need to create a new folder in
your <code>www</code> directory on your shell account. Then you need a virtual host for this folder, for this you have to send us an email asking for this.

After your new virtual host has been configured, you need to do the same steps that you would do for a regular WordPress installation, i.e. the steps in the section above.

You can also use WordPress' [https://codex.wordpress.org/Create_A_Network multisite] option.
If you need more help with this, you can find it here: [https://wordpress.org/support/forum/multisite here].

[[Category:CMSs]]

Exporting your KU Leuven class schedule and calendar

2019-11-10T21:26:34Z

Pcy: zet vertaalde termen in cursief

While relatively unknown, it is possible to create an automatically updating iCal feed of your KULoket agenda without using external services.

# Set up agenda sync on KU Loket
## Visit [http://kuloket.be/ KU Loket]
## Go to the '''Agenda''' tab [[File:KUL-Agenda-Step1.PNG|thumb|200px]]
## Click '''Agenda sync'''
## Click '''Configure agenda''' (''Agenda instellen'') [[File:KUL-Agenda-Step2.PNG|thumb|200px]]
## Change the switch '''Show schedule in my agenda''' (''Toon uurrooster in mijn agenda'') to '''On'''. [[File:KUL-Agenda-Step3.PNG|thumb|200px]] You will have to wait about 15 minutes before continuing to the next step.
# Visit https://owa.student.kuleuven.be and log in with your KU Leuven credentials.
# In the top menu bar, click '''Calendar''' (''Agenda'')
# On the top right (below the menu bar), click the '''Share''' (''Delen'') button. A side-panel appears.
# Enter a non-KU Leuven email address in the '''Share with''' (''Delen met'') textfield. After filling the email address, press the enter key.
# Make sure '''Full details''' (''Volledige informatie'') is selected in the dropdown next to your email address
# Click the '''Send''' (''Verzenden'') button at the top of the side-panel.
# You will receive an email with two weblinks. The first link shows your calendar in your webbrowser, the second link is your iCal feed.

Some applications will not accept a <code>webcal://</code> URL.
If that is the case you can simply modify the URL to start with <code>https://</code>

[[Category:Tutorials]]

Using Adminer

2019-11-10T21:25:03Z

Pcy: fix typos

You can access both your MySQL and PostgreSQL databases using Adminer, though not both at the same time. This application can be found on https://adminer.ulyssis.org. To login you need to use your MySQL or PostgreSQL password, this password is different from your account password for security reasons as well as convenience. In case you've forgotten your passwords you can get it from your website's configuration file. This is usually called config.php, wp-config.php, settings.php or something similar. You can change your database passwords through our control panel [https://ucc.ulyssis.org/ UCC], but keep in mind to then also change the password in relevant configuration files, or your applications may stop working correctly.

To use MySQL, please use the server <code>mysql.ulyssis.org</code>. In case of PostgreSQL, please use <code>pgsql.ulyssis.org</code>.

== Basic Usage ==

When logging in using MySQL, you will see an overview of all your databases. When using PostgreSQL you will see all databases that have been created by all of our users (this is a known problem with Adminer), though you won't be able to view them.

You can then view databases and tables. For each table you can view the records, view and change the structure, add records, take backups, etc. Sadly no official documentation is available, though Adminer has a [https://sourceforge.net/p/adminer/discussion/ forum] where you can ask for help.

== Making Backups ==

{{notice|Keep in mind|If you are backing up and/or restoring a larger database, it's advised to use command line tools since they are more performant than webtools and don't have any timeouts that could interrupt your backup/restore. Please refer to [[Making Backups]] for more details.}}
Adminer has an export option which can be used to backup the structure and/or data of databases and tables. When no database or table has been selected, the export button in the sidebar allows to export all databases at the same time. When a specific database or table is selected, that database or table is exported. You can specify to save the file, in what format, and whether structures and data should be dropped, truncated or created. You can later restore backups by uploading the file through the form available through the import button in the sidebar. To make restoring easier, we suggest you backup individual databases or even individual tables and use the SQL format.

[[Category:Databases]]

Using PHPPgAdmin

2019-11-10T21:24:07Z

Pcy: fix typos

You can access your PostgreSQL databases using PHPPgAdmin. This application can be found on https://phppgadmin.ulyssis.org. To login you need to use your PostgreSQL password, this password is different from your account password for security reasons as well as convenience. In case you've forgotten your PostgreSQL password you can get it from your website's configuration file. This is usually called config.php, wp-config.php, settings.php or something similar. You can change your database passwords through our control panel [https://ucc.ulyssis.org/ UCC], but keep in mind to then also change the password in relevant configuration files, or your applications may stop working correctly.

== Basic Usage ==

You can login by clicking on the only server in the left sidebar ''PostgreSQL voor gebruikers, kringen en organisaties''. Once you've logged in, you will see an overview of all your databases. You can then view databases, schemas and tables by clicking on them or navigating through the sidebar. For each table you can view the records, view and change the structure, add records, take backups, etc. Official documentation of all functionality is sadly lacking, but you can still refer to [http://phppgadmin.sourceforge.net/doku.php?id=faq_docs the official documentation]

== Making Backups ==

{{notice|Keep in mind|If you are backing up and/or restoring a larger database, it's advised to use command line tools since they are more performant than webtools and don't have any timeouts that could interrupt your backup/restore. Please refer to [[Making Backups]] for more details.}}
PHPPgAdmin has an export option which can be used to backup the structure and/or data of databases, schemas and tables, as well as more advanced features such as sequences and functions. When no database, schema or table has been selected, the export tab in the top menu allows to export all databases at the same time. When a specific database or table is selected, that database or table is exported. You can decide whether you wish to export the structure, the data or both, as well as the format and if DROPs need to be included. You can later restore backups by uploading the file through the form on the SQL page (top right corner). To make restoring easier, we suggest you backup individual databases or even individual tables and use the SQL format instead of COPY.

[[Category:Databases]]

Using PHPMyAdmin

2019-11-10T21:22:30Z

Pcy: fix typos

You can access your MySQL databases using PHPMyAdmin. This application can be found on https://phpmyadmin.ulyssis.org. To login you need to use your MySQL password, this password is different from your account password for security reasons as well as convenience. In case you've forgotten your MySQL password, you can get it from your website's configuration file. This is usually called config.php, wp-config.php, settings.php or something similar. You can change your database passwords through our control panel [https://ucc.ulyssis.org/ UCC], but keep in mind to then also change the password in relevant configuration files, or your applications may stop working correctly.

== Basic Usage ==

Once you've logged in, you will see your username on the left. You can click the plus sign right next to your name to reveal all your databases. You can then view databases and tables. For each table you can view the records, view and change the structure, add records, take backups, etc. Detailed documentation is available on the PHPMyAdmin [https://www.phpmyadmin.net/docs/ official documentation website]

== Making Backups ==

{{notice|Keep in mind|If you are backing up and/or restoring a larger database, it's advised to use command line tools since they are more performant than webtools and don't have any timeouts that could interrupt your backup/restore. Please refer to [[Making Backups]] for more details.}}
PHPMyAdmin has an export option which can be used to backup the structure and/or data of databases and tables. When no database or table has been selected, the export tab in the top menu allows to export all databases at the same time. When a specific database or table is selected, that database or table is exported. You can either accept the default settings, or ask for more settings, to specificy whether any checks, DROPs or time settings are required, as well as to specify if you wish to export the structure, the data or both. You can restore backups at a later point in time by uploading the file through the form on the import tab. To make restoring easier, we suggest you backup individual databases or even individual tables.

[[Category:Databases]]

Making Backups

2019-11-10T21:19:47Z

Pcy: fix typos

ULYSSIS takes backups of all files, databases, settings and repositories 1-4 times a week. These backups can be restored in case of severe server failure or in case of an emergency (if for example a user by mistake deletes all of their site). It is, however, more convenient that users take their own backups when they do experiments on their account.

== A backup of your files ==
You can use the methods described in [[Accessing your files]] to download a copy of all of your files or specific folders you will be working on. If something goes wrong, you can easily restore files to a previous state by re-uploading those you have downloaded and saved.

== A backup of your databases ==
To take a backup of your database you simply use the export function of PHPMyAdmin, PHPPgAdmin and/or Adminer as described on [[Using PHPMyAdmin]], [[Using PHPPgAdmin]] and [[Using Adminer]].

If you are backing up and/or restoring a larger database, it's advisable to use command line tools since they are more performant than the web-based tools and don't have any timeouts that could interrupt your backup/restore.

=== MySQL command line ===

To take a backup, execute the following command on one of our shellservers (with the right database name filled in):

mysqldump -h mysql.ulyssis.org -p username_database > backup.sql

This will prompt you for your database password (please refer to [[Using MySQL]] if you don't know your password) and then dump the entire database to backup.sql file as SQL.

To restore your backup you can use the mysql command on one of our shellservers (with the right database name filled in), whatever SQL file you specify will be executed:

mysql -h mysql.ulyssis.org -p username_database < backup.sql

Please keep in mind that by default mysqldump includes statements in the SQL file that will delete all tables that will be restored.

If you wish to have more control over different settings when taking or restoring please, you can refer to the respective man pages of mysqldump and mysql using <code>man mysqldump</code> and <code>man mysql</code>

=== PostgreSQL command line ===
To take a backup, execute the following command on one of our shellservers (with the right database name filled in):

pg_dump -h pgsql.ulyssis.org -W --clean username_database > backup.sql

This will prompt you for your database password (please refer to [[Using PostgreSQL]] if you don't know your password) and then dump the entire database to backup.sql file as SQL with COPY statements. If you prefer INSERT instead of COPY statements, you can add <code>--inserts</code> to your command.

To restore your backup you can use the pg_restore command on one of our shellservers (with the right database name filled in), whatever SQL file you specify will be executed:

psql -h pgsql.ulyssis.org -W username_database < backup.sql

Please keep in mind that because we specified <code>--clean</code> earlier, our SQL file includes statements that will delete all tables, sequences, functions and schemas that will be restored.

If you wish to have more control over different settings when taking or restoring please, you can refer to the respective man pages of pg_dump and psql using <code>man pg_dump</code> and <code>man psql</code>

[[Category:Files]]
[[Category:Databases]]