Skip to content

Commit edc395a

Browse files
committed
Edited a bit of the docs in README.md
1 parent fece1a8 commit edc395a

File tree

1 file changed

+50
-26
lines changed

1 file changed

+50
-26
lines changed
Lines changed: 50 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
[![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/factorio-server-charts)](https://artifacthub.io/packages/search?repo=factorio-server-charts)
2-
2+
[![Factorio](https://img.shields.io/static/v1?label=Factorio&message=v1.1.70&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IB2cksfwAAAAlwSFlzAAALEwAACxMBAJqcGAAACPtJREFUeJzVVglQVFcWbZYGBJHNBruhaWjo5f/f3XQD3c2ibMKggoJBowKyNluDLBJXBI2OCyEqronjBokCyqKiuIABjWabKSuJM6k4i5OqmFgxiZPJJMRlxDMXo0nLSKbKyaRqXtWpX//V//ec99699zwe7/9xvLtuildXWUhhU1FQQd1sNtnD2T6ApscRrH4RAR83xNRc22DEx+v1eG+V8U6Qv8dOml5EKCHMIcQRxv4cXNZPmvzkhei+C8v1eLsmBANLDDAGiDppepUF6gjSp2a9uikh4fUVEa1y4bgaejUR5hKSQyXjpvQuCMn57Yrom50FHHpKOHTkKhGvlFwYIWAY6qciv7k9Nu+rjcZvvtwahVdKDdcnc17NVXHebQPl7OU/1QZ/9YelxqH24nAcTFehZR6LprkcTLHq2zNjZO9qZYJ9VlbfC+DbWGUumiovSw9XLKT3WEIwQU6wG5X8ytYUwScNEYOfE/nvVkeix6zGvvmau5cW64cuL9bjwqJIdJaFoTk/GE05QfjNHAaNqQqsT+XQatLhVFXwnZ1ZqveyjcKWzkLu0uGi0Durk7WDkTJR68NdWUl4hmD7RAE7ixOtNqUb9g0sj8TJYiXaslh0Lk7E6XVp6KiMwLEFOhw1q9BVzOII4VSpCseKVHg1R4296Rz2Z6jQUxaKixWhQ69V6NBhYvFiqhpLpwUPermO3WxxPMZRd6E0Ru29OJ4dbE5n8dqmDFx4OR+HKOjpchVOELrNCiJRor+CBJQxeKOSwesLGBwpVGHnPBXWJvhia5wI++co0Z4jx6E8FlmTNINuYx03WQh4ZlQBn22OExwz6b45uHwmzm/JxIlSDQaqaGXlarSZGLQUaXCoUI3mXA5tFLy3hEVfGYe9OQxa8znsJOKGeB9snyxCe6YSFTH+tzxdnJstyKt4P1Win9UbN3ywRI/zjZm0xRocL1GQCBZ7MxnsmKXA6lgvVBpcYNY6YoXBGZsTRdiXwaEpm3akhMHxQoaOg8WGSE+UG33BiSdc5j1eHdGjkl+rj/K+vlZ/69LzieguDaEyU+IIldqe+RxeSPCGWcZHWoDDjUl+jn0Gkf2RJH/7gefU/Ot1IWOwZ46C8kGNoySgJZfFZkrOeSpfJKulf3Oys623EFDGe1LHPFYRafPli9E1Hywzon99KgVi0VFEq8lWYUOiGFkB/HshwjFnbG2sfm0RrGSK1FGwdeKYVY0Txw7tpiTsymfQRf+2UmJWRAZgvl5xX+fjMbJRTfiB+NNN8Vs+35Lwzu9rw66eK9ff7l+fhqMVEUTO4SCd9cZ5alRrnWAUOZyjGn9+RCDZcIz9SZ62BxKc9+2ZJUN7ngrHixkcJSENUwKRHSxDEufz/oj/9D8I+LYx/IvPG2NxeoGGVKvQ25hB5EFoKeSwO0+D2kQ/ZATaf+vqyN88IsgSwphHcQ5MdQ86nM3eO1Kge1DCvaUM9s+Wo4gTwhQqvcMJxja5OPA3WBxDGMGNN7gjeuhaYzyOFrFom8+gZ0MaWnMZWj1ldoEWi2NESPG1u2ptZTVy9cPZbPNIwMIIT7duc/AXXRWROEbVcpzyp3meHMu07tiVosDBDBZVk9nB6Tr5FYsYtbz3V4VfPWQ23Gt8lrpaGoOO2iS0mzg0U5A9+RqsoXJK8rH7C2XNSAHP8SzaaprS3e30yqlfHFkYjY48BifN1MjmyVAd5PagJ3QXKlEep8Bsg/Lrx+JM1Mod9DIJo5MIlzwTFnhvW7Yer5o0OECN5RWTGlunS5EltfuHq4PtxhEChh3P65GA5pn+3B/byu4eLdGjt1iB/nIGTbMCUaFxpbJk0E07bIqWY1pQwA2LGMssC4HXWxP5ekuJAU35WuyixtJMO7EvW4NqtROihHYnRwgYxgyC1cYod+s3V0/d/uGJFegrYHGpWok+M4PV8RKkysYjP1R4vyRC+F0U4/t3ndT7jYf/qQiejwk4Xxe+8MxCPV7O1WEPCeiiIO1ku9um+6Oc5d+eKOQftrF+LBfqnPjWky4ujTV/1L/2n6frknCWtn6gQokD2Qxmq0UIFE2Am6PDeRsrXj0d45qHycvnPWlcXBct618SNvRSbghaqZy6zOT3VFIH89XYkixBbbDDkJmzuzJF4nB4ks+Y/Zkat85XTCF//mvP0qGz61JxqoDB2TI5bbcS9dOk0PtOQMAEwdd8GxvL44t6Ivmj0V9leGtHVjC2pQbiMLlZbzmLduqGLXncg0zeOk2M9b/ywbY0BbqXx+Pcuhk4URn5gPwirbx/gQKd5BEFoSKofH3g7T7O8rKylOA0KvnN9WHGN2sibu/MVGFNkj92pQWik0S0DZco7UTn8DNXjY4cDn3UdnuL1ThbzOEcueJbVQpcrFSih75fHO6JRKkHWJHgpp2tTYOFgFzeaBfXnuooUVdp6LWXTEE4UKDC7iw1lsfRahMk2JuhRAvlwiG6A3ST8/VShr9WyeJkmQIDZMfvLFTgLJlWZ7YSK8IFyAsSoHaqDMkKj09tra3W8h5P3MAnCjAl6I1zwpg76RFK7CYz2TFXjslyAVRiIXL1vmhIDsTudDInkxJnyR37CGfMdDEZ7v0ZCrJgX2TJXbAg3AcNz6rIrlmsSQm8rxK6nhkhYPaoR5AWxi2bHiwbStEH3NMKnT50cbA75Stw/0gpFg1pJSLMUHihJNgTa6JFqI8VYVGEiHq9N+ICvODn6QHf8a73swzi+xvprlhPbTg+yA9aqfgG38Z63UPySp6lEf2bgGCx9RSd/Dmpp9vwh/EEzVh7vr+/l3sJ4+P1tkEiuGuOC0BxhBgmgzeMvm4QCTwg9HC7JXBxvkrfHne3tzmeqvX6KpyRgPUT3xG6u56gONW872/W40cl/09DJ/FwSJS6HN6bRW06m3yCnjF+Lt85O9ifoETbzvuxVecxXo4pQf4TzonHuw37BUNwfGpiy5GuEy6pI2NZlRKIlTMCofJyGmmztbyfuvH8t6NqKjvTwEjBSiVg/MUQOI8ZvmgMd7YcQgzBjzfalfvnGKkRnItW7j9HIfGuZPzE1S6ODhE07f4/I/wlxr8AAkgaqTYaX18AAAAASUVORK5CYII=&labelColor=4c2c2c&color=8c6c6c)](https://www.factorio.com/)
3+
[![Chart Version](https://img.shields.io/static/v1?logo=Helm&logoColor=0f1689&message=v1.1.0&label=Helm%20Chart&labelColor=eeeeee&color=fefefe)](https://sqljames.github.io/factorio-server-charts/index.yaml)
4+
[![Image Version](https://img.shields.io/static/v1?logo=Docker&message=v1.1.70&label=Docker%20Image&labelColor=eeeeee&color=fefefe)](https://sqljames.github.io/factorio-server-charts/index.yaml)
35

46
# factorio-server-charts
57

@@ -11,35 +13,35 @@ This chart deploys Factorio on a [Kubernetes](http://kubernetes.io) cluster usin
1113

1214
## Prerequisites
1315

14-
- This chart does require a nodeport open if playing publicly.
15-
- networking knowledge to route the traffic to the appropriate port.
16+
- An open NodePort or a UDP capable LoadBalancer if playing publicly.
17+
- Networking knowledge to route the traffic to the appropriate port.
1618

1719
## Background
18-
This is something of a passion project for both learning kubernetes and because kubernetes is awesome.
19-
Because of this, I have only confirm this working on version 1.1.0 of factorio but I am sure it will work just fine on old versions as long as the schema doesn't change to much on the Secrets settings.
20+
This is something of a passion project for both learning kubernetes and because kubernetes is awesome.
21+
Because of this, I have only confirm this working on version 1.1.0 of Factorio, but I am sure it will work just fine on old versions as long as the schema doesn't change to much on the Secrets settings.
2022

21-
However, with the way this is implemented if you want to make it backwards compatible, you can update the appropriate sections in the values.yaml file to have the items added or removed to the json files that are required by factorio. Server-settings, map-gen-settings, etc.
23+
However, with the way this is implemented if you want to make it backwards compatible, you can update the appropriate sections in the values.yaml file to have the items added or removed to the json files that are required by factorio. Server-settings, map-gen-settings, etc.
2224

23-
I did run into one issue on my setup, and I feel like it will likely come up again if people follow along. The factorio server is defaulting to run on port 30000 instead of 34197 because the default nginx port range for ingress does not have 34197 within the normal port range. This shows the line of code that specifically is causing the issue inside kubernetes :)
25+
I did run into one issue on my setup, and I feel like it will likely come up again if people follow along. The Factorio server is defaulting to run on port 30000 instead of 34197 because the default nginx port range for ingress does not have 34197 within the normal port range. This shows the line of code that specifically is causing the issue inside kubernetes :)
2426
https://github.com/kubernetes/kubernetes/blob/59876df736c41093363f4c198aeec05e29c9c902/cmd/kube-apiserver/app/server.go#L197
2527

2628
## Releases
27-
Releases are published using the official helm release action in github.
29+
Releases are published using the official helm release action in github.
2830
https://github.com/helm/chart-releaser-action
2931

3032
## Quick Start
31-
- create a values.yaml file
32-
- set the following options
33+
- Create a values.yaml file
34+
- Set the following options
3335

34-
```
36+
```yaml
3537
rcon:
3638
external: false
3739

38-
nodeSelector:
40+
nodeSelector:
3941
kubernetes.io/hostname: "<name of your node>" #this makes it easier for firewall rules and makes sure things dont change
4042

41-
#making sure the game doesnt auto update on redeploy
42-
#https://hub.docker.com/r/factoriotools/factorio/
43+
# making sure the game doesnt auto update on redeploy
44+
# https://hub.docker.com/r/factoriotools/factorio/
4345
image:
4446
tag: "<set me to the appropriate docker tag>"
4547

@@ -61,25 +63,43 @@ white_list: #put the people you want to play with you based on factorio names
6163

6264
server_settings:
6365
name: Factorio-2022-01-kubernetes
64-
tags:
66+
tags:
6567
- modded
6668
visibility:
6769
public: true
70+
require_user_verification: true
71+
72+
account:
73+
# Existing secret containing a valid factorio.com username and either a password or a token
74+
# Example:
75+
#
76+
# apiVersion: v1
77+
# kind: Secret
78+
# metadata:
79+
# name: account-secret
80+
# data:
81+
# username: <username in base64>
82+
# password: <password in base64>
83+
#
84+
# accountSecret: account-secret
85+
accountSecret: ''
6886
# Your factorio.com login credentials. Required for games with visibility public
6987
username: ''
70-
# Authentication token.
88+
password: ''
89+
# Authentication token. May be used instead of password above.
7190
token: ''
91+
92+
serverPassword:
7293
# password required to log into the factorio server
7394
game_password: ''
74-
require_user_verification: true
95+
# Existing Secret containing a `game_password` data entry
96+
passwordSecret: ''
7597
```
7698
77-
## installing mods
78-
79-
change enabled to true, follow comments below.
99+
## Installing mods
100+
To Install mods, change `mods.enabled` to `true`, add any offical mods by their URL name under the `mods.portal` section, and any unofficial mods in the `mods.unofficial`section.
80101

81-
If the factorio server doesn't start, check that the logs don't have an error with the mods. They are pretty verbose
82-
```
102+
```yaml
83103
mods:
84104
enabled: true
85105
# in order to use the mods portal you will need to specify the username and token in the server_settings.
@@ -88,15 +108,19 @@ mods:
88108
- Krastorio2
89109
- StorageTank2_Updated
90110
- early-robots
91-
# unofficial section is meant to just allow you to download and place folders into the mods folder.
111+
# unofficial section is meant to just allow you to download and place folders into the mods folder.
92112
# we will not check version compatibility automatically with these downloads.
93113
# you can encounter an error if the file names dont match what the mod is expecting for example
94-
#Error Util.cpp:83: Failed to load mod "Squeak-Through": Filename of mod
114+
#Error Util.cpp:83: Failed to load mod "Squeak-Through": Filename of mod
95115
# /factorio/mods/Squeak-Through.zip doesn't match the expected Squeak Through_1.8.2.zip (case sensitive!)
96116
unofficial:
97117
- url: "https://github.com/Suprcheese/Squeak-Through/archive/refs/tags/1.8.2.zip"
98118
name: "Squeak Through_1.8.2.zip"
99119
```
100120

101-
## Readme
102-
Readme was generated from the [chart-doc-gen](https://github.com/kubepack/chart-doc-gen) tool.
121+
If the Factorio server doesn't start, check that the logs don't have an error with the mods. They are pretty verbose.
122+
123+
## Parameters
124+
125+
## Readme
126+
Readme was generated from the [chart-doc-gen](https://github.com/kubepack/chart-doc-gen) tool.

0 commit comments

Comments
 (0)