Skip to content

Commit

Permalink
Remove non-installed instructions from docs (#1310)
Browse files Browse the repository at this point in the history
With the virtualenv as recommended install method this isn't really necessary anymore, so we'd rather avoid supporting this.
  • Loading branch information
wil93 authored Dec 24, 2024
1 parent 8c0ff79 commit 168ea0e
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 45 deletions.
6 changes: 2 additions & 4 deletions .github/ISSUE_TEMPLATE/Bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,11 @@ If instead you have found a possible bug, please go ahead filing the issue using

### Logs

[Please attach relevant logs of the component(s) that caused the problem; you can find them in /var/local/log/cms/ (if CMS was running
installed) or in ./log (if it was running from the local copy).]
[Please attach relevant logs of the component(s) that caused the problem; you can find them in /var/local/log/cms/.]

### System Information

**CMS version:** [master, or a specific version]
**Was CMS installed:** [yes or no]
**Using a virtualenv:** [yes or no]
**How was CMS installed:** [virtualenv, docker, ...?]
**Postgres version:** [if relevant]
**Distribution and version:** [if relevant]
3 changes: 1 addition & 2 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ or write on the **support mailing list**

To help with the troubleshooting, you can upload on some online
pastebin the relevant **log files**, that you can find in
/var/local/log/cms/ (if CMS was running installed) or in ./log (if it
was running from the local copy).
`/var/local/log/cms/`.

If you encountered a bug, please file an
[issue](https://github.com/cms-dev/cms/issues) on **GitHub** following
Expand Down
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,7 @@ required (you can see the archives on [Google
Groups](https://groups.google.com/forum/#!forum/contestms-support)).

To help with the troubleshooting, you can upload on some online pastebin the
relevant **log files**, that you can find in `/var/local/log/cms/` (if CMS was
running installed) or in ./log (if it was running from the local copy).
relevant **log files**, that you can find in `/var/local/log/cms/`.

If you encountered a bug, please file an
[issue](https://github.com/cms-dev/cms/issues) on **GitHub** following the
Expand Down
37 changes: 0 additions & 37 deletions docs/Installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -228,43 +228,6 @@ Apart from validity, there are many possible tweaks to reduce the variability in
We suggest following isolate's `guidelines <https://github.com/ioi/isolate/blob/c679ae936d8e8d64e5dab553bdf1b22261324315/isolate.1.txt#L292>`_ for reproducible results.


.. _installation_running-cms-non-installed:

Running CMS non-installed
=========================

To run CMS without installing it in the system, you need first to build the prerequisites:

.. sourcecode:: bash

python3 prerequisites.py build

There are still a few steps to complete manually in this case. First, add CMS and isolate to the path and create the configuration files:

.. sourcecode:: bash

export PATH=$PATH:./isolate/
export PYTHONPATH=./
cp config/cms.conf.sample config/cms.conf
cp config/cms.ranking.conf.sample config/cms.ranking.conf

Second, perform these tasks (that require root permissions):

* create the ``cmsuser`` user and a group with the same name;

* add your user to the ``cmsuser`` group;

* set isolate to be owned by root:cmsuser, and set its suid bit.

For example:

.. sourcecode:: bash

sudo useradd cmsuser
sudo usermod -a -G cmsuser <your user>
sudo chown root:cmsuser ./isolate/isolate
sudo chmod u+s ./isolate/isolate

Updating CMS
============

Expand Down

0 comments on commit 168ea0e

Please sign in to comment.