{"id":1561,"date":"2024-01-23T13:52:56","date_gmt":"2024-01-23T21:52:56","guid":{"rendered":"https:\/\/arelle.org\/arelle\/?page_id=1561"},"modified":"2025-04-23T13:51:56","modified_gmt":"2025-04-23T20:51:56","slug":"edgar-renderer-installation","status":"publish","type":"page","link":"https:\/\/arelle.org\/arelle\/pub\/edgar-renderer-installation\/","title":{"rendered":"Edgar Renderer Installation"},"content":{"rendered":"

Quick Start to Install EDGAR\u00ae<\/sup> Renderer<\/h1>\n

Several alternative installation strategies can be followed:<\/p>\n

    \n
  1. Install a pre-built application. \u00a0These are available with embedded Python and require no developer skills.<\/li>\n
  2. Install from sources on gitHub. (See Technical Operation<\/a>)<\/li>\n<\/ol>\n

    Once installed there are two strategies for using the EDGAR renderer:<\/p>\n

      \n
    1. Interactively from its GUI. \u00a0(This now includes a local viewer using the same components as the sec.gov website.)<\/li>\n
    2. Technical Operation: from command line, as a web service, or polled operation as a daemon service. (See Technical Operation<\/a>)<\/li>\n<\/ol>\n

      Installing<\/h2>\n

      Pre-built application<\/h3>\n\n\n\n\n\n\n\n\n\n
      \n

      Download<\/h3>\n<\/th>\n

      		us site<\/th>\neu cn sites<\/th>\n<\/tr>\n
      Windows 64:
      \n(Installer)<\/td>\n      		\n\n\tDownload “Win 64 installer”\tarelle-win.exe\t\t– Downloaded 341027 times\t\t– 73.89 MB<\/small>\n<\/a>\n<\/td>\neu<\/a><\/td>\n<\/tr>\n
      cn<\/a><\/td>\n<\/tr>\n
      macOS App:<\/td>\n\n\n\tDownload “macOS (ARM64)”\tarelle-macos-arm64.dmg\t\t– Downloaded 86313 times\t\t– 151.41 MB<\/small>\n<\/a>\n<\/td>\neu<\/small><\/a><\/td>\n<\/tr>\n
      cn<\/small><\/a><\/td>\n<\/tr>\n
      Linux x86 64: (Ubuntu)
      \n(Installer)<\/td>\n      		\n\n\tDownload “Ubuntu Linux”\tarelle-ubuntu.tgz\t\t– Downloaded 62930 times\t\t– 123.89 MB<\/small>\n<\/a>\n<\/td>\neu<\/a><\/td>\n<\/tr>\n
      cn<\/a><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
        \n
      • Download and install.\n
          \n
        • It isn’t necessary to remove old versions first.<\/li>\n
        • If you don’t have administrator rights on your computer, install to a directory that you do have rights to (such as under Documents).<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n

          User Operation<\/h2>\n

          Interactively from its GUI<\/h3>\n

          Start Arelle (with installed app, from the Windows start menu \"start or click on arelleGUI.exe, or Mac Application Arelle.app \"start).<\/p>\n

          Check that the EDGAR renderer plugin is installed and enabled: help\u2192manage plugins. \"manage
          \nIf EDGAR Renderer is not shown, press Select\u2192EDGAR Renderer\u2192ok\u2192close).
          \n\"select
          \nClick yes when asked to restart.
          \n\"allow<\/p>\n

          If behind a firewall with Microsoft NTLM proxy service (common in large enterprises), also install the internet proxy plugin for NTLM (help\u2192manage plugins\u2192select\u2192Internet NTLM proxy handler\u2192ok\u2192close).
          \n\"select
          \nIt may be necessary to start your browser and open a public website (such as google) to “prime” NTLM for your user account, before Arelle can access the outside internet.<\/div>\n

          For validation using EDGAR Filer Manual, Tools\u2192Validation\u2192Select Disclosure System
          \n\"select
          \nSelect an EDGAR Filing Manual validation mode, such as Pragmatic, and press ok.
          \n\"select
          \nEnable Disclosure system checks, this menu entry is a checkmark toggle, click so it is enabled.
          \n\"check<\/p>\n

          Open an SEC filing, click \"open and select the instance document or inline html document. After successful loading the local viewer should display the SEC rendering engine results. If it’s an inline html document, click (Source)<\/span> top menu entry to see the html form with fact information highlighted by ixviewer.
          \n\"inline
          \nRedline markups in the inline document set are now shown with the View menu selection “Workstation Redline Mode”. (These markups are a private communication from filer to SEC personnel, for SEC workstations upon request. They are not disseminated to the public.)<\/p>\n

          For filer manual validation click \"validate.<\/p>\n","protected":false},"excerpt":{"rendered":"

          Quick Start to Install EDGAR\u00ae Renderer Several alternative installation strategies can be followed: Install a pre-built application. \u00a0These are available with embedded Python and require no developer skills. Install from sources on gitHub. (See Technical Operation) Once installed there are two strategies for using the EDGAR renderer: Interactively from its GUI. \u00a0(This now includes a […]<\/p>\n","protected":false},"author":3,"featured_media":0,"parent":55,"menu_order":1,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-1561","page","type-page","status-publish","hentry"],"jetpack_shortlink":"https:\/\/wp.me\/P1cfuV-pb","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/arelle.org\/arelle\/wp-json\/wp\/v2\/pages\/1561","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/arelle.org\/arelle\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/arelle.org\/arelle\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/arelle.org\/arelle\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/arelle.org\/arelle\/wp-json\/wp\/v2\/comments?post=1561"}],"version-history":[{"count":2,"href":"https:\/\/arelle.org\/arelle\/wp-json\/wp\/v2\/pages\/1561\/revisions"}],"predecessor-version":[{"id":1564,"href":"https:\/\/arelle.org\/arelle\/wp-json\/wp\/v2\/pages\/1561\/revisions\/1564"}],"up":[{"embeddable":true,"href":"https:\/\/arelle.org\/arelle\/wp-json\/wp\/v2\/pages\/55"}],"wp:attachment":[{"href":"https:\/\/arelle.org\/arelle\/wp-json\/wp\/v2\/media?parent=1561"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}