Changes between Version 7 and Version 8 of FATE/Fateserver


Ignore:
Timestamp:
Mar 7, 2014, 6:08:48 AM (6 years ago)
Author:
Timothy_Gu
Comment:

Guide finished

Legend:

Unmodified
Added
Removed
Modified
  • FATE/Fateserver

    v7 v8  
    1818=== Install fateserver ===
    1919
    20 1. Get Apache httpd. On Debian derivatives do
    21    {{{#!sh
     201. Get Apache HTTP Server. On Debian derivatives do
     21   {{{
    2222   sudo apt-get install apache2
    2323   }}}
     24
    24252. Change ownership of `/var/www` to the yourself so you can edit it.
    2526
    2627   This is only required if the fateserver source is located under a root-only directory like /var/www.
    27    {{{#!sh
     28   {{{
    2829   sudo chown -hR (yourusername):(yourusername) /var/www
    2930   }}}
    3031
    31323. Get fateserver and `mkdir` server data directory.
    32    {{{#!sh
     33   {{{
    3334   cd /var/www
    3435   git clone git://git.ffmpeg.org/fateserver
     
    3637   }}}
    3738
    38 3. Make /var/www/fateserver the root of the server. This is OS-dependant, but on Ubuntu you have to modify `/etc/apache2/sites-available/000-default.conf`: From
     394. Make /var/www/fateserver the root of the server. This is OS-dependant, but on Ubuntu you have to modify `/etc/apache2/sites-available/000-default.conf`: From
    3940   {{{
    4041   DocumentRoot /var/www
     
    4546   }}}
    4647
    47 4. Allow CGI to be executed in Apache, add this to `/etc/apache2/apache2.conf`:
     485. Allow CGI to be executed in Apache, add this to `/etc/apache2/apache2.conf`:
    4849   {{{
    4950   LoadModule cgi_module /usr/lib/apache2/modules/mod_cgi.so
     
    5455   }}}
    5556
    56 5. Create a new user for fateserver.
     576. Create a new user for fateserver. These two steps are not required, and doing so is only recommended if you want to really set up a FATE website. If you just want to test fateserver, you don't need to.
     58  a. Creating the user:
     59     {{{
     60     sudo adduser fate
     61     sudo chown -hR fate:fate /var/www/fateweb
     62     }}}
     63  b. In `/home/fate/.ssh/authorized_keys`, add one entry for each submitter with the following:
     64     {{{
     65     command="FATEDIR=/var/www/fateweb FATE_USER=timothy_gu /var/www/fateserver/fate-recv.sh" <submitter's public key>
     66     }}}
     67     This makes sure they get identified for fateserver and they can only run that one command, so they don't get a shell.
    5768
    58    This is not required, and is only recommended if you want to really set up a FATE website. If you just want to test fateserver, you don't need to.
    59    {{{
    60    sudo adduser fate
    61    chown -hR fate:fate /var/www/fateweb
    62    }}}
    63 
    64 6. In that user's `.ssh/authorized_keys`, add one entry for each submitter with the following:
    65    {{{
    66    command="FATEDIR=/var/www/fateweb FATE_USER=<some identifier of your choice for that submitter> /var/www/fateserver/fate-recv.sh" <submitter's public key>
    67    }}}
    68 
    69    This makes sure they get identified for fateweb and they can only run that one command, so they don't get a shell.
    70 
    71    This is only required if you created a fate user.
     69     I won't get into the basics of creating SSH keys and stuff like that: there are tons of guides online.
    7270
    73717. Edit FATE.pm, set the `$fatedir` variable to the fateweb path, if yours is different from the default (`/var/www/fateweb`):
    74    {{{#!perl
     72   {{{
    7573   our $fatedir = "/your/path";
    7674   }}}
     
    8078=== Feed fateserver Data To Display ===
    8179
    82 There are two ways to give fateserver the data it needs to display: using or not using SSH.
     80There are two ways to give fateserver the data it needs to display: using or not using SSH. The official way to submit results is through SSH; but if you are just testing or playing around with fateserver, you can save the hassle by using a small trick.
    8381
    8482==== Using SSH ====
    8583
    86 '''WIP'''
     84See [https://ffmpeg.org/fate.html the official guide for submitting test] for instructions to submit test results. Simply change this line in your fate config script:
    8785
    88 ==== Not Using SSH. ====
     86{{{
     87fate_recv="ssh -T fate@fate.ffmpeg.org" # command to submit report
     88}}}
     89to
     90{{{
     91fate_recv="ssh -T fate@localhost"       # command to submit report
     92}}}
     93
     94==== Not Using SSH ====
     95
     96If you are just testing fateserver and not use it for real, not using SSH might be a good idea. You can first create a wrapper file for `fate_recv` with contents:
     97
     98{{{
     99#!/bin/sh
     100export FATEDIR=/var/www/fateweb FATE_USER=<yourid>
     101/var/www/fateserver/fate-recv.sh -
     102}}}
     103
     104And then change this line in your fate config script:
     105
     106{{{
     107fate_recv="ssh -T fate@fate.ffmpeg.org" # command to submit report
     108}}}
     109to
     110{{{
     111fate_recv="/path/of/your/script.sh"     # command to submit report
     112}}}
     113
     114After that, follow [https://ffmpeg.org/fate.html the official guide for submitting test].
     115
     116=== Using Git ===
    89117
    90118'''WIP'''
    91119
    92 Thanks to Ramiro Polla for writing the initial version of this guide. Major updates made by Timothy Gu.
     120== Acknowledgements ==
     121
     122Thanks to Ramiro Polla for writing the initial version of this guide. Major updates (in 2014) made by me (Timothy Gu).