426
edits
imported>Errorage No edit summary |
|||
(19 intermediate revisions by 8 users not shown) | |||
Line 1: | Line 1: | ||
{{Needs revision|reason=More like I will fix this|user=[[User:Jando|jando]]}} | |||
This page contains the information and steps needed to download the latest version of the code, compile it and host your own server. | This page contains the information and steps needed to download the latest version of the code, compile it and host your own server. | ||
== Licensing == | == Licensing == | ||
The | The /tg/station 13 source code is under [http://www.gnu.org/licenses/agpl-3.0.html GNU AGPL v3 license] and the assets are [http://freedomdefined.org/Licenses/CC-BY-SA CC-BY-SA]. | ||
== Downloading == | == Downloading == | ||
We use GitHub to host our project | We use GitHub to host our project. | ||
A zip download is available here: [https://github.com/yogstation13/Yogstation-TG] | |||
If you don't want to download 30MB of data every time an update is made, you can [[Setting up git|follow this guide]] to set up TortoiseGit. | |||
[[File:Download za git.png]] | |||
== "I did not change anything, but the code does not work anymore!" == | == "I did not change anything, but the code does not work anymore!" == | ||
Line 52: | Line 31: | ||
To get a simple server running first | To get a simple server running first | ||
* Download the source code as explained above | * Download the source code as explained [[Downloading_the_source_code#Downloading|above]] | ||
* Open | * Open yogstation.dme in dream maker (double click it) | ||
* Once it opens select Build > Compile | * Once it opens select Build > Compile | ||
* Wait until it compiles. Once it does a new file " | * Wait until it compiles. Once it does a new file "Yogstation.dmb" will be created in the same folder where "yogstation.dme" is. The dmb file has an orange icon. Compile time usually takes between 1 and 10 minutes, depending on your computer. Dream maker will show as 'not responding' during this time, but it is compiling. | ||
* Open dream daemon (Win7: start menu > all programs > BYOND > Dream Daemon; Win8: start > type Dream Daemon > Dream Daemon) | * Open dream daemon (Win7: start menu > all programs > BYOND > Dream Daemon; Win8: start > type Dream Daemon > Dream Daemon) | ||
* Select the "..." in the lower right corner and select the file " | * Select the "..." in the lower right corner and select the file "yogstation.dmb". | ||
* Click the "GO" button and wait until it changes to a red "stop" button. Starting the server usually takes between 1 and 5 minutes. It is fully started once you can normally interact with Dream Daemon and a byond://xxx.xxx.xxx.xxx:xxxxx link is present at the bottom. | * Click the "GO" button and wait until it changes to a red "stop" button. Starting the server usually takes between 1 and 5 minutes. It is fully started once you can normally interact with Dream Daemon and a byond://xxx.xxx.xxx.xxx:xxxxx link is present at the bottom. | ||
* Click the yellow button (former "...") to auto-join | * Click the yellow button (former "...") to auto-join | ||
Line 78: | Line 57: | ||
* Go to the following address in your browser: [http://localhost/phpmyadmin http://localhost/phpmyadmin] (will only work once you start up both Apache and MySQL in the XAMPP Control Panel) | * Go to the following address in your browser: [http://localhost/phpmyadmin http://localhost/phpmyadmin] (will only work once you start up both Apache and MySQL in the XAMPP Control Panel) | ||
* Click on the button titled SQL in the row of buttons at the top. | * Click on the button titled SQL in the row of buttons at the top. | ||
* Open the file 'SQL/tgstation_schema.sql' in notepad and copy its content. You can also find it [https://github.com/ | * Open the file 'SQL/tgstation_schema.sql' in notepad and copy its content. You can also find it [https://github.com/tgstation/-tg-station/blob/master/SQL/tgstation_schema.sql here], but it may be newer than the version you are using. | ||
* Paste the file's content into the input field for sql in phpmyadmin and hit 'Execute' in the bottom right | * Paste the file's content into the input field for sql in phpmyadmin and hit 'Execute' in the bottom right | ||
* Once you execute this, a new database should be added to the list on the left, called 'feedback'. If not, refresh the page. If you click on the database, it should show you all the tables it includes. At this point, you have created the database 'infrastructure'. You now have to create a user for it. | * Once you execute this, a new database should be added to the list on the left, called 'feedback'. If not, refresh the page. If you click on the database, it should show you all the tables it includes. At this point, you have created the database 'infrastructure'. You now have to create a user for it. | ||
* Click on 'SQL' in the top again, and execute the following statement: CREATE USER 'myuser'@'localhost' IDENTIFIED BY 'mypass'; GRANT ALL ON feedback.* TO 'myuser'@'%'; Replace both instances of myuser with some username and mypass with some password. Be careful to copy all the apostrophes. This will create a new user and grant him all privileges for the feedback database. | * Click on 'SQL' in the top again, and execute the following statement: CREATE USER 'myuser'@'localhost' IDENTIFIED BY 'mypass'; GRANT ALL ON feedback.* TO 'myuser'@'%'; Replace both instances of myuser with some username and mypass with some password. Be careful to copy all the apostrophes. This will create a new user and grant him all privileges for the feedback database. | ||
* Please keep phpmyadmin open for a while longer. | * Please keep phpmyadmin open for a while longer. | ||
* Open the file: [https://github.com/ | * Open the file: [https://github.com/tgstation/-tg-station/blob/master/config/dbconfig.txt config/dbconfig.txt] in notepad | ||
* Make sure to set it so that: | * Make sure to set it so that: | ||
** SQL_ENABLED does not have a # in front of it | ** SQL_ENABLED does not have a # in front of it | ||
Line 95: | Line 74: | ||
=== Database based banning === | === Database based banning === | ||
Offers temporary jobbans, admin bans, cross-server bans, keeps bans logged even after they've expired or were unbanned, and allows for the use of the off-server | Offers temporary jobbans, admin bans, cross-server bans, keeps bans logged even after they've expired or were unbanned, and allows for the use of the off-server ban log. | ||
To enable database based banning: | To enable database based banning: | ||
Line 101: | Line 80: | ||
* Open config/config.txt | * Open config/config.txt | ||
* Add a # in front of BAN_LEGACY_SYSTEM, so the line looks like "#BAN_LEGACY_SYSTEM" | * Add a # in front of BAN_LEGACY_SYSTEM, so the line looks like "#BAN_LEGACY_SYSTEM" | ||
* Done. Note that any legacy bans are no longer enforced once this is done! So it's a good idea to do it when you're starting up. | * Done. Note that any legacy bans are no longer enforced once this is done! So it's a good idea to do it when you're starting up. | ||
=== Database based administration === | === Database based administration === | ||
'''DATABASE BASED ADMINISTRATION CURRENTLY DOES NOT WORK.''' | <font color='red'>'''DATABASE BASED ADMINISTRATION CURRENTLY DOES NOT WORK.'''</font> | ||
The rest of this section remains for when it gets fixed. | |||
<div class="toccolours mw-collapsible mw-collapsed" style="width:600px"> | <div class="toccolours mw-collapsible mw-collapsed" style="width:600px"> | ||
Offers a changelog for changes done to admins, which increases accountability (adding/removing admins, adding/removing permissions, changing ranks); allows admins with +PERMISSIONS to edit other admins' permissions ingame, meaning they don't need remote desktop access to edit admins; Allows for custom ranks, with permissions not being tied to ranks, offering a better ability for the removal or addition of permissions to certain admins, if they need to be punished, or need extra permissions. Enabling this can be done any time, it's just a bit tedious the first time you do it, if you don't have direct access to the database. | Offers a changelog for changes done to admins, which increases accountability (adding/removing admins, adding/removing permissions, changing ranks); allows admins with +PERMISSIONS to edit other admins' permissions ingame, meaning they don't need remote desktop access to edit admins; Allows for custom ranks, with permissions not being tied to ranks, offering a better ability for the removal or addition of permissions to certain admins, if they need to be punished, or need extra permissions. Enabling this can be done any time, it's just a bit tedious the first time you do it, if you don't have direct access to the database. | ||
Line 117: | Line 99: | ||
* If your database ever dies, your server will revert to the old admin system, so it is a good idea to have admins.txt and admin_ranks.txt set up with some admins too, just so the loss of the database doesn't completely destroy everything. | * If your database ever dies, your server will revert to the old admin system, so it is a good idea to have admins.txt and admin_ranks.txt set up with some admins too, just so the loss of the database doesn't completely destroy everything. | ||
</div> | </div> | ||
If you need more help contact | If you need more help contact [[Community|#coderbus]]. | ||
For additional database-related tutorials, see [[Working with the database]]. | For additional database-related tutorials, see [[Working with the database]]. |
edits