Navigation:  Quick Start >

Administration Console

Previous pageReturn to chapter overviewNext page

 

Administration Console is a very useful tool for the administrators, like the Linux "Shell" or the Windows "Command prompt". You can run administration commands or Lua scripts on the console.

 

Wing FTP Server provides two types of consoles - the Application Console and the Web-based Console.

 

Application Console is an integral application of Wing FTP Server. You can run this application with the command prompt(or the Linux "shell") on the machine that is installed  with Wing FTP Server. This application can be very useful when you are running Linux without GUI and you don't want to manage your server from remote web browser.

 

Open a command window(or Linux "Shell") and navigate to where Wing FTP Server is located, then start the program "wftpconsole" with the required parameters. If you are not  sure how to do this,  type command "wftpconsole --help" and you will see a list of all the allowed options like:

 

 Allowed options:

 --help                          Show this message

 -u [ --username ] arg            Username (Required field)

 -p [ --password ] arg            Password (Required field)

 -h [ --host ] arg                Remote host IP address,default is localhost

 -P [ --port ] arg                Remote host port,default is 5466

 -f [ --file ] arg                Parse and execute local Lua <file>

 -s [ --ssl ]                    Use SSL connection

 

 

Note 1: After successful connection to the local administration, please type the following command to log in:

       wftpconsole -u admin -p admin12345

Note 2: The "lua>>" prompt indicates that you are in the Wing FTP Server administration and it is ready to receive your commands.
Note 3: By entering command "help", you will get a list of useful administration commands.
Note 4: You can input Lua script and execute it,  like "print(1+2+3)".
Note 5: Quit the console by typing "exit"

 

 

Web-based Console

 

Web-based Console is quite similar to the Application Console. It is located in the Web-based Administration. When you have logged on the Web admin, click on the left panel of "Administration -> Console" and the Web-based Console will appear on the right panel.

Type the "help" command, then you can see a list of administration commands.

 

admin-console

 

 

 

Type the "domainlist" command to get the domain list on your server.

 

command-domainlist

 

 

 

Type the "userlist" command with a specified domain name to get the user list for that domain.

 

command-userlist

 

 

Lua Scripts

 

Apart from the Administration commands, Lua scripts can also be run here. With Lua scripts, the Administration Console works like a Lua Interpreter.

 

command-lua

 

command-lua2

 

There are lots of Server APIs and Variables available for your scripts.

 

command-lua3

 

 

You can switch the Single/Multiple line mode by clicking the icon before the "lua>>" prompt or by pressing "Ctrl + M".

 

Single Line:        single-line

 

 

Multiple Lines:        multi-line

 

Press "Ctrl+Enter" to submit your multi-lines Lua Scripts code.

 

command-lua4