github.com/ncw/rclone@v1.48.1-0.20190724201158-a35aa1360e3e/docs/content/http.md (about)

     1  ---
     2  title: "HTTP Remote"
     3  description: "Read only remote for HTTP servers"
     4  date: "2017-06-19"
     5  ---
     6  
     7  <i class="fa fa-globe"></i> HTTP
     8  -------------------------------------------------
     9  
    10  The HTTP remote is a read only remote for reading files of a
    11  webserver.  The webserver should provide file listings which rclone
    12  will read and turn into a remote.  This has been tested with common
    13  webservers such as Apache/Nginx/Caddy and will likely work with file
    14  listings from most web servers.  (If it doesn't then please file an
    15  issue, or send a pull request!)
    16  
    17  Paths are specified as `remote:` or `remote:path/to/dir`.
    18  
    19  Here is an example of how to make a remote called `remote`.  First
    20  run:
    21  
    22       rclone config
    23  
    24  This will guide you through an interactive setup process:
    25  
    26  ```
    27  No remotes found - make a new one
    28  n) New remote
    29  s) Set configuration password
    30  q) Quit config
    31  n/s/q> n
    32  name> remote
    33  Type of storage to configure.
    34  Choose a number from below, or type in your own value
    35   1 / Amazon Drive
    36     \ "amazon cloud drive"
    37   2 / Amazon S3 (also Dreamhost, Ceph, Minio)
    38     \ "s3"
    39   3 / Backblaze B2
    40     \ "b2"
    41   4 / Dropbox
    42     \ "dropbox"
    43   5 / Encrypt/Decrypt a remote
    44     \ "crypt"
    45   6 / FTP Connection
    46     \ "ftp"
    47   7 / Google Cloud Storage (this is not Google Drive)
    48     \ "google cloud storage"
    49   8 / Google Drive
    50     \ "drive"
    51   9 / Hubic
    52     \ "hubic"
    53  10 / Local Disk
    54     \ "local"
    55  11 / Microsoft OneDrive
    56     \ "onedrive"
    57  12 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH)
    58     \ "swift"
    59  13 / SSH/SFTP Connection
    60     \ "sftp"
    61  14 / Yandex Disk
    62     \ "yandex"
    63  15 / http Connection
    64     \ "http"
    65  Storage> http
    66  URL of http host to connect to
    67  Choose a number from below, or type in your own value
    68   1 / Connect to example.com
    69     \ "https://example.com"
    70  url> https://beta.rclone.org
    71  Remote config
    72  --------------------
    73  [remote]
    74  url = https://beta.rclone.org
    75  --------------------
    76  y) Yes this is OK
    77  e) Edit this remote
    78  d) Delete this remote
    79  y/e/d> y
    80  Current remotes:
    81  
    82  Name                 Type
    83  ====                 ====
    84  remote               http
    85  
    86  e) Edit existing remote
    87  n) New remote
    88  d) Delete remote
    89  r) Rename remote
    90  c) Copy remote
    91  s) Set configuration password
    92  q) Quit config
    93  e/n/d/r/c/s/q> q
    94  ```
    95  
    96  This remote is called `remote` and can now be used like this
    97  
    98  See all the top level directories
    99  
   100      rclone lsd remote:
   101  
   102  List the contents of a directory
   103  
   104      rclone ls remote:directory
   105  
   106  Sync the remote `directory` to `/home/local/directory`, deleting any excess files.
   107  
   108      rclone sync remote:directory /home/local/directory
   109  
   110  ### Read only ###
   111  
   112  This remote is read only - you can't upload files to an HTTP server.
   113  
   114  ### Modified time ###
   115  
   116  Most HTTP servers store time accurate to 1 second.
   117  
   118  ### Checksum ###
   119  
   120  No checksums are stored.
   121  
   122  ### Usage without a config file ###
   123  
   124  Since the http remote only has one config parameter it is easy to use
   125  without a config file:
   126  
   127      rclone lsd --http-url https://beta.rclone.org :http:
   128  
   129  <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/http/http.go then run make backenddocs -->
   130  ### Standard Options
   131  
   132  Here are the standard options specific to http (http Connection).
   133  
   134  #### --http-url
   135  
   136  URL of http host to connect to
   137  
   138  - Config:      url
   139  - Env Var:     RCLONE_HTTP_URL
   140  - Type:        string
   141  - Default:     ""
   142  - Examples:
   143      - "https://example.com"
   144          - Connect to example.com
   145      - "https://user:pass@example.com"
   146          - Connect to example.com using a username and password
   147  
   148  ### Advanced Options
   149  
   150  Here are the advanced options specific to http (http Connection).
   151  
   152  #### --http-no-slash
   153  
   154  Set this if the site doesn't end directories with /
   155  
   156  Use this if your target website does not use / on the end of
   157  directories.
   158  
   159  A / on the end of a path is how rclone normally tells the difference
   160  between files and directories.  If this flag is set, then rclone will
   161  treat all files with Content-Type: text/html as directories and read
   162  URLs from them rather than downloading them.
   163  
   164  Note that this may cause rclone to confuse genuine HTML files with
   165  directories.
   166  
   167  - Config:      no_slash
   168  - Env Var:     RCLONE_HTTP_NO_SLASH
   169  - Type:        bool
   170  - Default:     false
   171  
   172  <!--- autogenerated options stop -->