<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
  <channel>
    <title>RDepot – User Guide</title>
    <link>/2.9.1/documentation/user-guide/</link>
    <description>Recent content in User Guide on RDepot</description>
    <generator>Hugo -- gohugo.io</generator>
    <language>en-us</language>
    
	  <atom:link href="/2.9.1/documentation/user-guide/index.xml" rel="self" type="application/rss+xml" />
    
    
      
        
      
    
    
    <item>
      <title>Documentation: Create a Repository</title>
      <link>/2.9.1/documentation/user-guide/create-repository/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      
      <guid>/2.9.1/documentation/user-guide/create-repository/</guid>
      <description>
        
        
        &lt;p&gt;In order to create a new repository, go to &lt;strong&gt;Repositories&lt;/strong&gt; by clicking the corresponding entry in the left menu.&lt;/p&gt;
&lt;p&gt;&lt;img src=&#34;../img/repositories-wide.png&#34; alt=&#34;alt text&#34; title=&#34;Repository list&#34;&gt;&lt;/p&gt;
&lt;p&gt;Open the &lt;strong&gt;New repository&lt;/strong&gt; dialog by clicking the blue &lt;strong&gt;Create +&lt;/strong&gt; button in the top right corner of the page.&lt;/p&gt;
&lt;p&gt;&lt;img src=&#34;../img/create-repository.png&#34; alt=&#34;alt text&#34; title=&#34;New repository dialog&#34;&gt;&lt;/p&gt;
&lt;p&gt;Fill in the blanks correctly:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;strong&gt;Name&lt;/strong&gt;: a unique identifier for this repository. Even when this repository is deleted, this name is still unique and cannot be reused by other repositories.&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;Publication URI&lt;/strong&gt;: the external facing URL that users will see. It will be used in UI pages that RDepot users see. In our local demo deployment, this tends to be &lt;code&gt;http://localhost/repo/&amp;lt;repository-name&amp;gt;&lt;/code&gt; (as the included web proxy will redirect &lt;code&gt;/repo/&lt;/code&gt; requests to the associated repository web server).&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;Server address&lt;/strong&gt;: the (internal) URL that the RDepot manager uses when synchronizing changes to the repository. This should be set to the location of the RDepot Repo API. In our local demo deployment, this tends to be &lt;code&gt;http://oa-rdepot-repo:8080/&amp;lt;technology&amp;gt;/&amp;lt;repository-name&amp;gt;&lt;/code&gt; (&lt;code&gt;oa-rdepot-repo&lt;/code&gt; is the hostname of the RDepot Repo API Docker container in the demo &lt;code&gt;docker-compose.yaml&lt;/code&gt;). The icon button next to it will run a check to see whether the RDepot manager can reach the specified server address of the RDepot Repo API. Please make sure the RDepot manager can actually reach the specified server, as this will cause server issues during publishing if not configured correctly.&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;Technology&lt;/strong&gt;: one of the supported technologies, e.g. &lt;code&gt;R&lt;/code&gt; or &lt;code&gt;Python&lt;/code&gt;.&lt;/li&gt;
&lt;li&gt;(R only) &lt;strong&gt;Redirect to source&lt;/strong&gt;: when installing binary R packages, the repository web server will try to redirect missing binary R packages to the same (or newer) source R package within the same repository instead, before failing with a HTTP 404. This also may require additional configuration in the web proxy or web server, depending on your deployment. This additional configuration is already included in our local demo deployment.&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;Requires authentication&lt;/strong&gt;: checking this will cause the RDepot UI to show the install command to use when a repository requires authentication. For R repositories, installing packages requires using &lt;a href=&#34;https://craneserver.net/docs/client/r/&#34;&gt;crane&lt;/a&gt; and for Python repositories, installing packages requires using &lt;a href=&#34;https://craneserver.net/docs/client/python/&#34;&gt;crane-pip&lt;/a&gt;.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;Additional notes on the &lt;strong&gt;Publication URI&lt;/strong&gt;: the &lt;code&gt;/repo/&lt;/code&gt; part of the Publication URI depends on the deployment.
When hosting RDepot and the repository under the same domain, using a subpath will most likely be necessary (but another subpath can be used, as this is used to route traffic to the repository web server).
When hosting both RDepot and the repository on separate domains (for example, rdepot.example.com for RDepot and repos.example.com for the repository web server) it is not necessary to use a subpath, as routing can be done based on the (sub)domain.&lt;/p&gt;
&lt;p&gt;Additional notes on the &lt;strong&gt;Server address&lt;/strong&gt;: since RDepot v2.6.0 it is recommended to include the technology (r/python) as part of the URL. Not doing so will cause a deprecation warning to be shown in the UI. From RDepot v3.0, this will be mandatory.&lt;/p&gt;
&lt;p&gt;Then create the repository by clicking the corresponding blue &lt;strong&gt;submit&lt;/strong&gt; button.&lt;/p&gt;
&lt;p&gt;&lt;img src=&#34;../img/created-repository.png&#34; alt=&#34;alt text&#34; title=&#34;Repository created&#34;&gt;&lt;/p&gt;
&lt;p&gt;Your repository will be displayed as a new entry in the repositories table.&lt;/p&gt;

      </description>
    </item>
    
    <item>
      <title>Documentation: Upload Packages</title>
      <link>/2.9.1/documentation/user-guide/upload-packages/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      
      <guid>/2.9.1/documentation/user-guide/upload-packages/</guid>
      <description>
        
        
        &lt;p&gt;If you want to upload a new package, go to &lt;strong&gt;Upload packages&lt;/strong&gt; by clicking the entry in the left menu.&lt;/p&gt;
&lt;p&gt;&lt;img src=&#34;../img/upload-packages-wide.png&#34; alt=&#34;alt text&#34; title=&#34;Upload packages page&#34;&gt;&lt;/p&gt;
&lt;p&gt;Select the repository into which you want to upload packages by clicking on the dropdown menu in the middle of the page and selecting one from the list. Click continue to go to the next step.&lt;/p&gt;
&lt;p&gt;&lt;img src=&#34;../img/upload_python_packages.gif&#34; alt=&#34;alt text&#34; title=&#34;Uploading Python packages&#34;&gt;&lt;/p&gt;
&lt;p&gt;In the next step, add packages by clicking the gray box in the middle of the page or drag-and-drop files into the center of the screen.&lt;/p&gt;
&lt;p&gt;One can click on the &amp;ldquo;Replace&amp;rdquo; checkbox to the right of the package to replace packages in the repository with the same name and version. Replacing is unchecked by default.&lt;/p&gt;
&lt;p&gt;Starting from RDepot v2.5.0, notes can be added to any package upload. This can be used to specify release notes or other helpful information for maintainers (these are shown when reviewing submissions) and users (these are shown on the package details page) alike. Click the &amp;ldquo;Notes&amp;rdquo; checkbox to get started.&lt;/p&gt;
&lt;p&gt;&lt;img src=&#34;../img/add-notes-to-package-uploads.png&#34; alt=&#34;alt text&#34; title=&#34;Adding notes to package uploads&#34;&gt;&lt;/p&gt;
&lt;p&gt;Also new in RDepot v2.5.0: binary (Linux) packages for R. Click the &amp;ldquo;Binary file&amp;rdquo; checkbox and fill in the required fields: R version, architecture and (Linux) distribution. These values are configured on the server-side and can be modified by a server admin.&lt;/p&gt;
&lt;p&gt;&lt;img src=&#34;../img/binary-r-linux-packages.png&#34; alt=&#34;alt text&#34; title=&#34;Uploading binary R packages&#34;&gt;&lt;/p&gt;
&lt;p&gt;Additionally for R packages, there is also an option to generate a manual during the package upload process (see checkbox to the right of the package). Manual generation is checked by default. Manual generation is not supported for binary R packages.&lt;/p&gt;
&lt;p&gt;&lt;img src=&#34;../img/upload_r_packages.gif&#34; alt=&#34;alt text&#34; title=&#34;Uploading R packages&#34;&gt;&lt;/p&gt;
&lt;p&gt;If packages are uploaded successfully, there are green checkmarks to the left of the uploaded packages.
If there were any issues uploading the packages, red crosses are shown with the error message on hover.&lt;/p&gt;
&lt;p&gt;If you have the appropriate permissions (as an admin, a repository maintainer of the repository that you have uploaded the packages into or a package maintainer of the packages that you have uploaded), the package uploads or submissions were approved automatically.
If that is not the case, then the submissions need to be approved by the appropriate maintainer or admin first, before these package become available in the repository to be viewed and installed.&lt;/p&gt;
&lt;p&gt;After uploading a package, the system automatically chooses the maintainer for the package.
It does so using the following set of rules:&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;Is there any package maintainer for the package with that name and repository? If yes, the first returned package maintainer (by ID) will be chosen.&lt;/li&gt;
&lt;li&gt;Is there any repository maintainer for that repository? If yes, the first returned repository maintainer (by ID) will be chosen.&lt;/li&gt;
&lt;li&gt;The first returned admin (by ID) will be chosen.&lt;/li&gt;
&lt;/ol&gt;

      </description>
    </item>
    
    <item>
      <title>Documentation: Publish a Repository</title>
      <link>/2.9.1/documentation/user-guide/publish-repository/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      
      <guid>/2.9.1/documentation/user-guide/publish-repository/</guid>
      <description>
        
        
        &lt;p&gt;To publish a repository, go to &lt;strong&gt;Repositories&lt;/strong&gt; and click on the &lt;strong&gt;Published&lt;/strong&gt; checkbox.&lt;/p&gt;
&lt;p&gt;&lt;img src=&#34;../img/publish-repository.gif&#34; alt=&#34;alt text&#34; title=&#34;Publish a repository&#34;&gt;&lt;/p&gt;

      </description>
    </item>
    
    <item>
      <title>Documentation: View and Review Submissions</title>
      <link>/2.9.1/documentation/user-guide/view-a-submission/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      
      <guid>/2.9.1/documentation/user-guide/view-a-submission/</guid>
      <description>
        
        
        &lt;p&gt;To view and review submissions, go to &lt;strong&gt;Submissions&lt;/strong&gt;.
You can download any submitted packages by clicking the download icon in the actions column.&lt;/p&gt;
&lt;p&gt;As the uploader, if the submission is still in review, you can click the cancel icon in the actions column to cancel your submission.
As a maintainer or admin, a submission still in review can be either accepted or rejected by clicking on the appropriate icon in the actions column.&lt;/p&gt;
&lt;p&gt;&lt;img src=&#34;../img/submissions.png&#34; alt=&#34;alt text&#34; title=&#34;List of submissions&#34;&gt;&lt;/p&gt;
&lt;p&gt;If there are any notes added to a submission, the note icon in the actions column will be filled and the table row or note icon can be clicked to show the notes.&lt;/p&gt;

      </description>
    </item>
    
    <item>
      <title>Documentation: View and Install Packages</title>
      <link>/2.9.1/documentation/user-guide/view-packages/</link>
      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
      
      <guid>/2.9.1/documentation/user-guide/view-packages/</guid>
      <description>
        
        
        &lt;p&gt;To see package details, go to &lt;strong&gt;Packages&lt;/strong&gt; and click on the package you are looking for.
You will see the long description of the package.&lt;/p&gt;
&lt;p&gt;&lt;img src=&#34;../img/packages-page.png&#34; alt=&#34;alt text&#34; title=&#34;List of packages&#34;&gt;&lt;/p&gt;
&lt;p&gt;In order to see the package details page simply click on the details button (blue arrow in the Actions column).&lt;/p&gt;
&lt;p&gt;&lt;img src=&#34;../img/package-page.png&#34; alt=&#34;alt text&#34; title=&#34;R package details page&#34;&gt;&lt;/p&gt;
&lt;p&gt;You will be presented with the package details page, containing installation instructions, a download link and package details as well as the notes that were provided during the upload process.&lt;/p&gt;
&lt;p&gt;&lt;img src=&#34;../img/package-page-notes.png&#34; alt=&#34;alt text&#34; title=&#34;R package details page with notes&#34;&gt;&lt;/p&gt;
&lt;p&gt;&lt;img src=&#34;../img/python_package.gif&#34; alt=&#34;alt text&#34; title=&#34;Python package details page&#34;&gt;&lt;/p&gt;

      </description>
    </item>
    
  </channel>
</rss>
