Changes between Version 28 and Version 56 of Help/Preferences/Connection


Ignore:
Timestamp:
(multiple changes)
Author:
(multiple changes)
Comment:
(multiple changes)

Legend:

Unmodified
Added
Removed
Modified

  • Help/Preferences/Connection

    v28 v56  
    1 [[TranslatedPages]]
    2 = Preferences > Connection settings =
     1[[TranslatedPages(outdated=Page needs rework and better structure. Some screenshots are outdated.)]]
    32
    4 [[TOC(inline)]]
     3= Preferences > OSM Server =
     4[[PageOutline(2-4,Table of content)]]
    55
    6 == The URL to the OSM server == #ApiUrl
     6[[JOSMImage(preferences/connection,48,link=,middle,margin-right=20)]]
    77
    8 === Downloading and uploading to the default server ===
     8Connection Settings for the OSM server
    99
    10 [[Image(use-default-api-url.png)]]
     10== Downloading and uploading to the default server ==#ApiUrl
     11[[Image(use-default-api-url.png,link=)]]
    1112
    1213Most JOSM users want to exchange geo data with the standard OSM server operated by the OSM community.
    … …  
    1415Tick the respective checkbox in order to download from and upload to the standard server (see screenshot above). This is the default setting.
    1516
    16 === Advanced option: Downloading and uploading to a custom server ===
     17== Advanced option: Downloading and uploading to a custom server ==
    1718Some JOSM users need to configure the API URL of an OSM server because they are working with a custom server:
    18   * Some users are working with local installations of the OSM server
    19   * Some users are working with development and test instances of the OSM server (for instance with [http://api06.dev.openstreetmap.org]).
     19* Some users are working with local installations of the OSM server
     20* Some users are working with development and test instances of the OSM server (for instance with [https://api06.dev.openstreetmap.org]).
    2021
    21 [[Image(use-custom-api-url.png)]]
     22[[Image(use-custom-api-url.png,link=)]]
    2223
    2324In order to use a custom URL:
    24   1. Remove the tick in the checkbox for the standard API URL (see screenshot above)
    25   2. Enter the API URL
     251. Remove the tick in the checkbox for the standard API URL (see screenshot above)
     261. Enter the API URL
    2627 
    27 Click on '''Validate''' to test whether an OSM API server is available at the given URL. If so, JOSM will display the icon [[Image(source:/trunk/images/dialogs/changeset/valid.png)]] to the right of the input field for the API URL. If the URL isn't valid, JOSM will display the icon  [[Image(source:/trunk/images/warning-small.png)]].
     28Click on **Validate** to test whether an OSM API server is available at the given URL. If so, JOSM will display the icon [[JOSMImage(misc/green_check)]] to the right of the input field for the API URL. If the URL isn't valid, JOSM will display the icon [[JOSMImage(warning-small)]].
    2829
    2930
    30 == Authentication Settings ==#AuthenticationSettings
    31 
     31== Authentication ==#Authentication
    3232=== Working anonymously or with an OSM account ===
    33 
    3433You don't need to identify and authenticate yourself provided that you neither upload data to the OSM server nor download data for which you must authenticate first.
    3534
    36 If you work '''anonymously''' you are allowed
    37   * to download geo-data from the OSM server and save it to a local file
    38   * to download public GPS traces from the OSM server
    39   * to load geo data from a file, edit it, and save it back to a file
     35If you work **anonymously** you are allowed
     36* to download geo-data from the OSM server and save it to a local file
     37* to download public GPS traces from the OSM server
     38* to load geo data from a file, edit it, and save it back to a file
    4039
    4140However, you can't
    42   * upload geo-data to the OSM server. You can't created, update, or close changesets either.
    43   * download your private GPS traces
     41* upload geo-data to the OSM server. You can't created, update, or close changesets either.
     42* download your private GPS traces
    4443
    45 You are recommended to [http://www.openstreetmap.org/user/new?referer=%2F create an OSM user account]. By using [http://www.openstreetmap.org/user/new?referer=%2F this form] you can choose an '''OSM username''' and an '''OSM password''' both of which you will use below.
     44You are recommended to [osmwww:user/new?referer=%2F create an OSM user account]. By using [osmwww:user/new?referer=%2F this form] you can choose an **OSM username** and an **OSM password** both of which you will use below.
    4645
    4746=== Basic authentication ===
    48 {{{
    49 #!html
    50 <p style="background-color:rgb(253,255,221);padding: 10pt; border-color:rgb(128,128,128);border-style: solid; border-width: 1px;">
    51 <strong>Warning!</strong><br/>
    52 Basic authentication methode is quite unsecure. Please consider to use OAuth.
    53 The password is stored in plain text in the JOSM preferences file.
    54 Furthermore, it is transferred <strong>unencrypted</strong> in every request sent to the OSM server.
    55 <strong>Do not use a valuable password.</strong>
    56 </p>
    57 }}}
    58 
    5947Basic authentication is the basic mechanism to authenticate yourself at the OSM server.
    6048
    6149Here's a screenshot of the preferences panel for basic authentication:
    6250
    63 [[Image(basic-authentication.png)]]
     51[[Image(basic-authentication.2.png,link=)]]
    6452
    6553To use Basic Authentication
    6654
    67   1. Go to the tab '''Authentication''' in the Connection Preferences
    68   2. Select the authentication method '''Basic authentication'''
    69   3. Enter your OSM username and your OSM password
     551. Go to the register **OSM Server** in Preferences
     561. Select the authentication method **Basic authentication**
     571. Enter your OSM username and your OSM password
    7058
    71 === OAuth based authentication ===
    72 [http://oauth.net/ OAuth] is an open protocol to allow secure API authorization  in a simple and standard method from desktop and web applications. The OSM server supports OAuth in addition to basic authentication. 
     59=== OAuth 2.0 based authentication ===#oauth2
     60[https://oauth.net/2 OAuth 2.0] is an open protocol to allow secure API authorization in a simple and standard method from desktop and web applications. The OSM server supports OAuth 2.0 in addition to basic authentication.
    7361
    7462OAuth has two major advantages over basic authentication:
    75   1. Your OSM password doesn't have to be saved in clear text in the JOSM preferences file.
    76   2. Your OSM password has to be transferred encrypted '''only once''' over the Internet, in contrast to basic authentication where your OSM password is transferred unencrypted as part of every request sent from JOSM to the OSM server.
     631. Your OSM password doesn't have to be saved in clear text in the JOSM preferences file.
     641. Your OSM password has to be transferred encrypted **only once** over the Internet, in contrast to basic authentication where your OSM password is transferred unencrypted as part of every request sent from JOSM to the OSM server.
    7765
    78 For advanced users, OAuth has additional advantages:
    79   * With OAuth you can generate restricted Access Tokens which you given somebody else such that another mapper can act on your behalf. For instance, a mapper could generate an Access Token which grants somebody else the right to download its private GPS traces. Even if he gives this Access Token to somebody else, his OSM password is kept private. In addition, he can revoke the special Access Token at any time. JOSM supports this kind of advanced configuration in the [wiki:/Help/Dialog/OAuthAuthorisationWizard OAuth Authorisation Wizard] with the authorisation procedure '''Manual authorization'''.
     66OAuth 2.0 uses [wikitr:/Help/Preferences/RemoteControl Remote Control] to receive the token from the OAuth server. If Remote Control is disabled in preferences (default setting) it is temporally enabled to receive the token and then disabled again.
     67**Note**: If you have issues authenticating, you can disable remote control in other running instances of JOSM and disable ''then'' re-enable it in the JOSM instance you are trying to authenticate.
    8068
    81 To use OAuth based Authentication
     69Once initialized the access token is represented with the following options:
    8270
    83   1. In the Connection Preferences go to the tab '''Authentication'''
    84   2. Select the authentication method '''OAuth based authentication'''
    85   3. Click on '''Authorise now''' to launch the [wiki:/Help/Dialog/OAuthAuthorisationWizard OAuth Authorisation Wizard] (see screenshot below)
     71[[Image(oauth-2-authentication.png,500,link=)]]
    8672
    87 [[Image(oauth-preferences-step-1.png)]]
    88 
    89 This will launch the [wiki:/Help/Dialog/OAuthAuthorisationWizard OAuth Authorisation Wizard]. Use one of the available authorization procedures in this dialog to get a valid '''Access Token'''.
    90 
    91 JOSM displays the retrieved Access Token in the preferences panel (see screenshot below):
    92 
    93 [[Image(oauth-preferences-step-2.png)]]
    94 
    95 Deselect the checkbox '''Save to preferences''' if you don't want to save the Access Token in the JOSM preferences. If you don't save it the Access Token will be lost when you close JOSM. If you later startup JOSM again you will have to retrieve a new Access Token to work with OAuth based authentication again.
    96 
    97 Click on '''Test Access Token''' to submit a test request with the token to the OSM server. JOSM will analyse whether this token is authorized to access the OSM server.
    98 
    99 Click on '''New Access Token''' to generate a new Access Token.
    100 
    101 ==== Advanced OAuth parameters ====
    102 Select the checkbox '''Display Advanced OAuth parameters''' to display the important OAuth parameters
    103   * the [http://oauth.net/core/1.0/#anchor3 Consumer Key] and the [http://oauth.net/core/1.0/#anchor3 Consumer Secret] identifying JOSM as OAuth consumer
    104   * the Request Token URL where JOSM can retrieve [http://oauth.net/core/1.0/#anchor3 Request Tokens]
    105   * the Access Token URL where JOSM can retrieve [http://oauth.net/core/1.0/#anchor3 Access Tokens]
    106   * the Authorise URL where JOSM users are redirected to to authorise a Request Token
    107 
    108 [[Image(oauth-advanced.png)]]
    109 
    110 == Proxy Settings == #ProxySettings
    111 JOSM communicates with the OSM server using the Hypertext Transfer Protocol ([http://en.wikipedia.org/wiki/Http HTTP]). If required it can relay its requests through a [http://en.wikipedia.org/wiki/Http_proxy HTTP proxy] or a [http://en.wikipedia.org/wiki/SOCKS SOCKS proxy].
    112 
    113   1. Go to the tab '''Proxy settings''' in the Connection Preferences
    114   2. Select one of the available options and enter additional configuration parameters
    115   3. Save the preferences
    116 
    117 [[Image(proxy-settings.png)]]
     73* Deselect the checkbox **Save to preferences** if you don't want to save the Access Token in the JOSM preferences. If you don't save it the Access Token will be lost when you close JOSM. If you later startup JOSM again you will have to retrieve a new Access Token to work with OAuth based authentication again.
     74* Click on **Test Access Token** to submit a test request with the token to the OSM server. JOSM will analyze whether this token is authorized to access the OSM server.
     75* Click on **Remove token** to remove the current token. The `Authorise now` button will reappear.
     76* Selecting the checkbox "Display Advanced OAuth Parameters" to get the [wikitr:/Help/Dialog/OAuthAuthorisationWizard#AdvancedOAuthparameters advanced OAuth parameters] displayed.
    11877
    11978
    120 === Using the standard system proxy ===
    121 If you always want to use the proxy defined as standard proxy on your computer you have to start up JOSM with a special command. The command line has to include the parameter {{{-Djava.net.useSystemProxies=true}}}, for instance
     79== New OSM account messages and max age of closed OSM Notes ==
     80=== New OSM account messages ===
     81JOSM, by default, periodically checks for unread OSM account messages. Unchecking ''**Periodically check for new messages**'' will disable the check (''advanced preference'': `message.notifier.enabled`). Below the checkbox the interval in minutes can be set (''advanced preference'': `message.notifier.interval`). The default value is `5` minutes.
    12282
    123   {{{java -Djava.net.useSystemProxies=true -jar josm.jar}}}
     83=== Max age of closed OSM Notes ===#OSMNotes
     84The maximum age in days of closed [wikitr:/Help/Dialog/Notes OSM Notes] can be set (''advanced preference'': `osm.notes.daysClosed`). The default value is `7` days. See [wikitr:/Help/Dialog/Notes#AdvancedPreferences Advanced preferences for notes] for details.
    12485
    125 === Using the manually configured proxy ===
    126 If there is a need for personal authentication for your proxy, remember to include the NT-domain with your username, e.g. ''domain\username''. This issue is due to proxy implementation in java.net.HttpURLConnection.
     86
     87== Overpass server ==#OverpassServer
     88''**([wikitr:/Help/ExpertMode Expert mode] only)**'' \\
     89Configure the Overpass API instance used for downloading OSM data (for instance in [wikitr:/Help/Action/Download#DownloadfromOverpassAPI Download from Overpass API]) (''advanced preference'': `download.overpass.server`). See [osmwiki:Overpass_API#Public_Overpass_API_instances for a list of servers]. \\
     90With a checked ''**Use Overpass server for object downloads**'' the overpass server is used for all actions which request to download specified objects like [wikitr:/Help/Action/DownloadObject Download Object], [wikitr:/Help/Action/DownloadParentWaysAndRelation Download parent ways/relations …] or downloading (incomplete) members of relations (''advanced preference'': `download.overpass.for-multi-fetch`).
    12791
    12892----
    129 Back to [wiki:/Help/Action/Preferences Preferences][[Br]]
    130 Back to [wiki:Help Main Help]
     93Back to [wikitr:/Help/Action/Preferences Preferences] \\
     94Back to [wikitr:/Help/Menu/Edit Edit Menu] \\
     95Back to [wikitr:/Help/Menu Main Menu] \\
     96Back to [wikitr:/Help Main Help]