Skip to content

Commit

Permalink
Update config.ini descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
cathery committed Apr 15, 2020
1 parent 720d43e commit d0f8d27
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 17 deletions.
42 changes: 27 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,50 @@
# sys-ftpd

Put the contents of the sd_card folder in the root of your sd-card or else the Module won't work!

This is a nintendo-switch sysmodule which runs an ftpd-server in the background (on port 5000 with no auth).

The ftpd is basically copy paste from [this](https://github.com/DavidBuchanan314/ftpd) ftpd-fork.

Put the contents of the sd_card folder in the root of your sd-card or else the sound effects won't work!
The key difference between sys-ftpd-light and [sys-ftpd](https://github.com/jakibaki/sys-ftpd) is that it applies a lot of changes to significantly reduce memory usage (from ~7MB to ~1MB). This includes removing all sound effects and reducing the buffer size reserved for the ftpd server.

Hotkeys: To help with security while there is are no login credentials, debugging, or otherwise, you can toggle the state of the server using the (+) + (-) + (X) button combination.

Sound effects from:
https://freesound.org/people/jens.enk/sounds/434610/
https://freesound.org/people/jens.enk/sounds/434611/
https://freesound.org/people/rhodesmas/sounds/322897/
https://freesound.org/people/rhodesmas/sounds/322895/


---

Config Example (`/config/sys-ftpd/config.ini`):
Config Example (Located on your sd in `sdmc:/config/sys-ftpd/config.ini`):

```
[User]
user:=ftpd
# user:= -> Login username
[Password]
password:=12345
# password:= -> Login password
[Port]
port:=5000
# port:=5000 -> opens the server on port 5000 (using the console's IP address).
[Anonymous]
anonymous:=1
;if anonymous:=1 no login and password are needed!
;if anonymous:=0 must set user:= and Password!
# anonymous:=1 -> Allows logging into the ftpd server without username or password.
# anonymous:=0 -> Only allows logging into the ftpd server with the correct username and password. user and password (in fields above) must be set.
[Pause]
disabled:=0
keycombo:=PLUS+MINUS+X
# disabled:=1 -> Disables allowing sys-ftpd to be paused by pressing the key combination.
# disabled:=0 -> Allows sys-ftpd to be paused by pressing the key combination.
# keycombo:= -> The key combination used to pause sys-ftpd. Each key is separated by either a plus '+' or a space ' '. Up to 8 keys are allowed.
# The list of valid keys is as follows:
# A, B, X, Y, LS, RS, L, R, ZL, ZR, PLUS, MINUS, DLEFT, DUP, DRIGHT, DDOWN
[LED]
led:=1
# led:=1 -> LED flashes on connect (default)
# led:=0 -> LED does not flash on connect
```
17 changes: 15 additions & 2 deletions sd_card/config/sys-ftpd/config.ini
Original file line number Diff line number Diff line change
@@ -1,21 +1,34 @@
[User]
user:=ftpd

# user:= -> Login username

[Password]
password:=12345

# password:= -> Login password

[Port]
port:=5000

# port:=5000 -> opens the server on port 5000 (using the console's IP address).

[Anonymous]
anonymous:=1
#if anonymous:=1 no login and password needed !
#if anonymous:=0 must set user:= and Password:= !

# anonymous:=1 -> Allows logging into the ftpd server without username or password.
# anonymous:=0 -> Only allows logging into the ftpd server with the correct username and password. user and password (in fields above) must be set.

[Pause]
disabled:=0
keycombo:=PLUS+MINUS+X

# disabled:=1 -> Disables allowing sys-ftpd to be paused by pressing the key combination.
# disabled:=0 -> Allows sys-ftpd to be paused by pressing the key combination.
# keycombo:= -> The key combination used to pause sys-ftpd. Each key is separated by either a plus '+' or a space ' '. Up to 8 keys are allowed.
# The list of valid keys is as follows:
# A, B, X, Y, LS, RS, L, R, ZL, ZR, PLUS, MINUS, DLEFT, DUP, DRIGHT, DDOWN

[LED]
led:=1

Expand Down

0 comments on commit d0f8d27

Please sign in to comment.