Commit 453409aa authored by Robert Czechowski's avatar Robert Czechowski

Add logo to README.md

parent e9ae1898
Pipeline #880 passed with stages
in 23 minutes
# The Medal Contest Platform # The Medal Contest Platform ![Logo](static/images/medal_logo_small.png)
[![crates.io](https://img.shields.io/crates/v/medal?color=orange)](https://crates.io/crates/medal) [![crates.io](https://img.shields.io/crates/v/medal?color=orange)](https://crates.io/crates/medal)
[![documentation](https://img.shields.io/crates/v/medal?label=docs)](https://jim.test.bwinf.de/doc/medal/) [![documentation](https://img.shields.io/crates/v/medal?label=docs)](https://jim.test.bwinf.de/doc/medal/)
...@@ -52,15 +52,15 @@ The `config.json` configures the plattform (see src/config.rs). ...@@ -52,15 +52,15 @@ The `config.json` configures the plattform (see src/config.rs).
Needs `rustc` and `cargo` 1.40 (stable) or higher. Needs `rustc` and `cargo` 1.40 (stable) or higher.
Rust can be obtained here: https://rustup.rs/ Rust can be obtained here: https://rustup.rs/
Running Running
``` ```
make make
``` ```
compiles and runs a debug-/test-server. compiles and runs a debug-/test-server.
For production use, a release binary should be compiled and served behind a reverse proxy (nginx, apache, …). For production use, a release binary should be compiled and served behind a reverse proxy (nginx, apache, …).
``` ```
make release make release
``` ```
...@@ -81,7 +81,7 @@ upstream medal { ...@@ -81,7 +81,7 @@ upstream medal {
server { server {
# Other server settings here # Other server settings here
location ~* \.(yaml)$ { location ~* \.(yaml)$ {
deny all; deny all;
} }
...@@ -92,7 +92,7 @@ server { ...@@ -92,7 +92,7 @@ server {
location /tasks { location /tasks {
add_header Cache-Control "public, max-age=604800"; add_header Cache-Control "public, max-age=604800";
} }
location / { location / {
proxy_pass http://medal; proxy_pass http://medal;
...@@ -105,13 +105,13 @@ The following configuration can be used for an Apache 2.4 webserver: ...@@ -105,13 +105,13 @@ The following configuration can be used for an Apache 2.4 webserver:
ServerSignature Off ServerSignature Off
ProxyPreserveHost On ProxyPreserveHost On
AllowEncodedSlashes NoDecode AllowEncodedSlashes NoDecode
ProxyPass /static/ ! ProxyPass /static/ !
ProxyPass /tasks/ ! ProxyPass /tasks/ !
ProxyPass /favicon.ico ! ProxyPass /favicon.ico !
ProxyPass / http://[::1]:8080/ ProxyPass / http://[::1]:8080/
ProxyPassReverse / http://[::1]:8080/ ProxyPassReverse / http://[::1]:8080/
Alias "/tasks/" "/path/to/medal/tasks/" Alias "/tasks/" "/path/to/medal/tasks/"
Alias "/static/" "/path/to/medal/static/" Alias "/static/" "/path/to/medal/static/"
Alias "/favicon.ico" "/path/to/medal/static/images/favicon.png" Alias "/favicon.ico" "/path/to/medal/static/images/favicon.png"
...@@ -119,7 +119,7 @@ The following configuration can be used for an Apache 2.4 webserver: ...@@ -119,7 +119,7 @@ The following configuration can be used for an Apache 2.4 webserver:
<filesMatch "\.(css|jpe?g|png|gif|js|ico)$"> <filesMatch "\.(css|jpe?g|png|gif|js|ico)$">
Header set Cache-Control "max-age=604800, public" Header set Cache-Control "max-age=604800, public"
</filesMatch> </filesMatch>
<FilesMatch "\.yaml$"> <FilesMatch "\.yaml$">
Deny from all Deny from all
</FilesMatch> </FilesMatch>
...@@ -127,7 +127,7 @@ The following configuration can be used for an Apache 2.4 webserver: ...@@ -127,7 +127,7 @@ The following configuration can be used for an Apache 2.4 webserver:
<Directory "/path/to/medal/static/"> <Directory "/path/to/medal/static/">
Require all granted Require all granted
</Directory> </Directory>
<Directory "/path/to/medal/tasks/"> <Directory "/path/to/medal/tasks/">
Require all granted Require all granted
</Directory> </Directory>
...@@ -139,7 +139,7 @@ The following configuration can be used for an Apache 2.4 webserver: ...@@ -139,7 +139,7 @@ The following configuration can be used for an Apache 2.4 webserver:
Please format your code with `rustfmt` and check it for warnings with `clippy`. Please format your code with `rustfmt` and check it for warnings with `clippy`.
You can install those with You can install those with
``` ```
rustup component add rustfmt --toolchain nightly rustup component add rustfmt --toolchain nightly
rustup component add clippy rustup component add clippy
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment