First of all, if we want to include nUpdate into our project, we need to create a project in the Administration that will be linked to our application and provide it with updates.

Start the Administration whereever it is located on your computer. If you want to associate the project files directly with it, you will have to run it as admin the first time.



As soon as we are in the main menu like above, we click on "New project" in the top left hand corner.
nUpdate Administration will then begin to create a RSA key pair for the project. This may take a bit of time, so be patient.

Once it has finished, we're able to complete the form with our project data.

Name: The name of your project, e. g. "Music Player". This name can be anything you want and doesn't have to equal your project's name in Visual Studio or something like that. Of course, it makes sense if you do that but primarily it is just there to give it an ID and that you can find it.

Update-URL: This URL references to the directory in which the update files (packages, configuration file etc.) will be located. For example, let's store all of them in a folder called "updates". Then you would write something like: "http(s)://www.yourdomain.com/updates/". It is basically the URL that points to that specific directory on your webspace.

Local path: Here you can browse for a path and set a name for the project file. This is the file that will save all the information about this project locally and that is associated with the Administration. As we gave our project the name "Music Player" above, I will call this file "Music Player", too. Also I want to save on the desktop. The SaveFileDialog will help you to choose the path. In my case this would then be "D:\Desktop\Music Player.nupdproj". Just choose a location where you're able to find your project files easily, that's everything.

Save Credentials: This will determine whether the credentials you enter in the following pages will be encrypted with a default key and IV, or with your FTP-username and password. If you choose the second way which is safer, of course, then you will be asked for these credentials everytime you open up the project later. The other option is more convenient but not that safe (though the credentials won't be saved plain).


 

Let's move over to this page.
Here you need to enter your FTP-data. You're also able to use SFTP, PHP or whatever you want, too, if you choose "Custom" as protocol. However, as this would recommend an own project (class library), knowledge of the TransferInterface-project, interfaces and the usage of the classes that are defined there, I won't elaborate on that. This should be subject of another page.

FTP-Host: Here you enter the host of the FTP-Server, e. g. "ftp.yourdomain.com" or whatever it is. In my case this is "ftp1.php-friends.de" as my webspace is hosted by PHPFriends, absolutely awesome guys behind it. ;)

Port: This is the port that will be used for the connection to the server. By default, it is 21. This can of course vary in your case.

User: The first part of the credentials. Just enter the username that will be used for the login. This will be used as initializing vector for the encryption of all your credentials if you didn't check "Save credentials".

Password: The second part of the credentials. Just enter the password that will be used for the login. This will be used as key for the encryption of all your credentials if you didn't check "Save credentials". nUpdate Administration uses AES 256 by the way.

Mode: Here you're able to set which mode should be used for the connection. It is adviced to use "Passive", here.

Protocol: Choose one of the many protocols. Of course, FTP Secure is supported, either with SSL, or TLS. You can also choose the version and the type (implicit or explicit). If your server supports FTPS but you don't know which one you should use, then select "FTPS (TLS1 or SSL3 ...)". Nevermind, if you even don't know if your server supports FTPS, just test it out. nUpdate Administration will check if the connection works and then give you a feedback if something is wrong. Of course, FTPS is adviced.

Directory: This is the directory on your server where the update files will be stored in and that is referenced by the Update-URL set on the first page. As we have chosen "updates" as a folder in the URL, we will simply use "/updates/". If you aren't sure what directories you have on your FTP-server and you don't want to open FileZilla for that (I know that), then you can go ahead and click "Search on server". This may take up to a minute. After that, you can look around and directly choose a directory that you want to use.


Next up, we have that page. If you don't want to use a statistics server, just hit "Continue".

IMPORTANT: At the moment you need to have external access to your database in order to use statistics. In future versions this won't be necessary anymore. In most cases this feature can be enabled by your hoster.
Otherwise, if you want to use one, select "Use a statistics server" and hit the button "Select server..." on the right.

You should then see such a window. Before it appears, a popup will show up and tell you that you need to select a server and press "Enter" in order to use it. In your case this list may be empty.
Then click on "Add a server" and you will se that:

You need to enter the data that has been provided by your hoster for external access to a database.
In my case they have "web1.phpf-friends.de" for that. So I would write that into the first text field Host/Server.
The next field Database contains the name of your database, e. g. "Statistics" or whatever you named it.
The last field Username holds the username that should be used for external login. This should as well be given to you.

Click "Save" and now you should see that server in the list. Select it and press "Enter".
The page of the project-setup should show the name of the database at the position down there.



The last thing you need to do is entering the password for the external login. If you've done that, hit "Continue".


You're almost done with everything. The next page offers the possibility to add a proxy for the up- and downloads.

Proxy-Host: The host of your proxy including the port. This is a URL and you should see an example as a cue in the relating text field.

Username: The username to use for the login.
Password: The password to use for the login.

If you want to use the default credentials, then leave these two fields empty.


Congrats, you have just created your first project and are now able to open it up by clicking on "Open project" and selecting the project file where you saved it on your computer. :)

It should automatically check if the update configuration file is existing and create it on your server.

Last edited Jun 27, 2015 at 5:44 PM by Trade, version 9